Module io.sf.carte.css4j

Package io.sf.carte.doc.style.css.om

Class DefaultStyleFormattingContext

java.lang.Object

io.sf.carte.doc.style.css.om.DefaultDeclarationFormattingContext

io.sf.carte.doc.style.css.om.DefaultStyleFormattingContext

All Implemented Interfaces:

DeclarationFormattingContext, StyleFormattingContext, Serializable

Direct Known Subclasses:

InlineStyleFormattingContext

public class DefaultStyleFormattingContext
extends DefaultDeclarationFormattingContext
implements StyleFormattingContext

Default implementation of a StyleFormattingContext.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultStyleFormattingContext()

Method Summary

Modifier and Type	Method	Description
void	deepenCurrentContext()	This auxiliary method can be used to deepen the indentation at places where the general serialization flow does not give the desired results.
void	endCurrentContext(CSSRule rule)	Notify this context that the style was serialized for the given rule.
void	endInlinePropertyDeclaration(SimpleWriter wri)	End an inline property declaration.
void	endPropertyDeclaration(SimpleWriter wri)	Ends a property declaration in a rule style (does not apply to inline styles).
void	endRule(SimpleWriter wri, List<String> trailingComments)	Ends the serialization of a rule.
void	endRuleList(SimpleWriter wri)	Called after a list of rules is serialized.
void	endStyleDeclaration(SimpleWriter wri)	End a style declaration.
void	setParentContext(CSSRule rule)	Sets the parent of the rule being serialized, if any, providing additional context for the serialization.
void	startRule(SimpleWriter wri, List<String> precedingComments)	Starts the serialization of a rule.
void	startStyleDeclaration(SimpleWriter wri)	Start a style declaration (of either properties or descriptors).
void	updateContext(CSSRule rule)	Update this context for the given rule.
void	writeComment(SimpleWriter wri, String comment)	Serialize a comment that precedes a rule, with the appropriate indent.
void	writeFullIndent(SimpleWriter wri)	Serialize a full paragraph indent to a SimpleWriter.
void	writeImportantPriority(SimpleWriter wri)	Serialize an important priority declaration to a SimpleWriter.
void	writeLeftCurlyBracket(SimpleWriter wri)	Serialize a left curly bracket to a SimpleWriter.
void	writeLevelIndent(SimpleWriter wri)	Serialize one level of indentation to a SimpleWriter.
void	writeRightCurlyBracket(SimpleWriter wri)	Serialize a right curly bracket to a SimpleWriter.
void	writeSemiColon(SimpleWriter wri)	Serialize a semicolon to a SimpleWriter.
void	writeURL(SimpleWriter wri, String href)	Serialize a URL/URI to a SimpleWriter.

Methods inherited from class io.sf.carte.doc.style.css.om.DefaultDeclarationFormattingContext

startPropertyDeclaration, writeColon, writeComma

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.sf.carte.doc.style.css.DeclarationFormattingContext

startPropertyDeclaration, writeColon, writeComma, writeMinifiedValue, writeValue

Methods inherited from interface io.sf.carte.doc.style.css.StyleFormattingContext

writeShorthandValue

Constructor Details

DefaultStyleFormattingContext

public DefaultStyleFormattingContext()

Method Details

deepenCurrentContext

public void deepenCurrentContext()

Description copied from interface: StyleFormattingContext

This auxiliary method can be used to deepen the indentation at places where the general serialization flow does not give the desired results.

It is used only by the @font-feature-values rule.

Specified by:

deepenCurrentContext in interface StyleFormattingContext

endCurrentContext

public void endCurrentContext(CSSRule rule)

Description copied from interface: StyleFormattingContext

Notify this context that the style was serialized for the given rule.

It is called before StyleFormattingContext.endStyleDeclaration(SimpleWriter).

Specified by:

endCurrentContext in interface StyleFormattingContext

Parameters:

rule - the rule being serialized.

endPropertyDeclaration

public void endPropertyDeclaration(SimpleWriter wri)
                            throws IOException

Description copied from interface: DeclarationFormattingContext

Ends a property declaration in a rule style (does not apply to inline styles).

It is called after DeclarationFormattingContext.writeSemiColon(SimpleWriter).

Specified by:

endPropertyDeclaration in interface DeclarationFormattingContext

Overrides:

endPropertyDeclaration in class DefaultDeclarationFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

endInlinePropertyDeclaration

public void endInlinePropertyDeclaration(SimpleWriter wri)
                                  throws IOException

Description copied from interface: StyleFormattingContext

End an inline property declaration.

Called after DeclarationFormattingContext.writeSemiColon(SimpleWriter), only from inline styles.

Specified by:

endInlinePropertyDeclaration in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

endRule

public void endRule(SimpleWriter wri,
 List<String> trailingComments)
             throws IOException

Description copied from interface: StyleFormattingContext

Ends the serialization of a rule.

It is called after StyleFormattingContext.writeRightCurlyBracket(SimpleWriter).

Specified by:

endRule in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

trailingComments - the comments that go after the rule.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

endRuleList

public void endRuleList(SimpleWriter wri)
                 throws IOException

Description copied from interface: StyleFormattingContext

Called after a list of rules is serialized.

May be used for indentation.

Specified by:

endRuleList in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

endStyleDeclaration

public void endStyleDeclaration(SimpleWriter wri)
                         throws IOException

Description copied from interface: StyleFormattingContext

End a style declaration.

Called after StyleFormattingContext.endCurrentContext(CSSRule) and before StyleFormattingContext.writeRightCurlyBracket(SimpleWriter).

Specified by:

endStyleDeclaration in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

setParentContext

public void setParentContext(CSSRule rule)

Description copied from interface: StyleFormattingContext

Sets the parent of the rule being serialized, if any, providing additional context for the serialization.

It is called before StyleFormattingContext.startRule(SimpleWriter, List). However, this method being called does not guarantee that startRule() will be called.

Specified by:

setParentContext in interface StyleFormattingContext

Parameters:

rule - the parent rule. May be null.

startRule

public void startRule(SimpleWriter wri,
 List<String> precedingComments)
               throws IOException

Description copied from interface: StyleFormattingContext

Starts the serialization of a rule.

It is the first stage of the serialization of a rule. For example, in the case of style rules it is called before serializing the rule selector list. At-rules call it before writing the @-rule name.

Specified by:

startRule in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

precedingComments - the comments that precede the rule.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

startStyleDeclaration

public void startStyleDeclaration(SimpleWriter wri)
                           throws IOException

Description copied from interface: StyleFormattingContext

Start a style declaration (of either properties or descriptors).

Called after StyleFormattingContext.writeLeftCurlyBracket(SimpleWriter) and before serializing the style declaration.

Specified by:

startStyleDeclaration in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

updateContext

public void updateContext(CSSRule rule)

Description copied from interface: StyleFormattingContext

Update this context for the given rule.

For style rules, it is called after serializing the selector list and before StyleFormattingContext.writeLeftCurlyBracket(SimpleWriter). At-rules call it after writing the rule name.

May be used for indentation.

Specified by:

updateContext in interface StyleFormattingContext

Parameters:

rule - the rule being serialized.

writeComment

public void writeComment(SimpleWriter wri,
 String comment)
                  throws IOException

Description copied from interface: StyleFormattingContext

Serialize a comment that precedes a rule, with the appropriate indent.

Trailing comments are generally written directly by StyleFormattingContext.endRule(SimpleWriter, List) because no indent is necessary.

Specified by:

writeComment in interface StyleFormattingContext

Parameters:

wri - the writer to write to.

comment - the comment to serialize.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeFullIndent

public void writeFullIndent(SimpleWriter wri)
                     throws IOException

Description copied from interface: DeclarationFormattingContext

Serialize a full paragraph indent to a SimpleWriter.

Specified by:

writeFullIndent in interface DeclarationFormattingContext

Overrides:

writeFullIndent in class DefaultDeclarationFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeImportantPriority

public void writeImportantPriority(SimpleWriter wri)
                            throws IOException

Description copied from interface: StyleFormattingContext

Serialize an important priority declaration to a SimpleWriter.

If the property declaration has important priority, it is called after the value is written and before DeclarationFormattingContext.writeSemiColon(SimpleWriter).

Specified by:

writeImportantPriority in interface StyleFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeLeftCurlyBracket

public void writeLeftCurlyBracket(SimpleWriter wri)
                           throws IOException

Description copied from interface: StyleFormattingContext

Serialize a left curly bracket to a SimpleWriter.

Called after StyleFormattingContext.updateContext(CSSRule) and before StyleFormattingContext.startStyleDeclaration(SimpleWriter).

Specified by:

writeLeftCurlyBracket in interface StyleFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeLevelIndent

public void writeLevelIndent(SimpleWriter wri)
                      throws IOException

Description copied from interface: StyleFormattingContext

Serialize one level of indentation to a SimpleWriter.

Specified by:

writeLevelIndent in interface StyleFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeRightCurlyBracket

public void writeRightCurlyBracket(SimpleWriter wri)
                            throws IOException

Description copied from interface: StyleFormattingContext

Serialize a right curly bracket to a SimpleWriter.

Called after StyleFormattingContext.endStyleDeclaration(SimpleWriter) and before StyleFormattingContext.endRule(SimpleWriter, List).

Specified by:

writeRightCurlyBracket in interface StyleFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeSemiColon

public void writeSemiColon(SimpleWriter wri)
                    throws IOException

Description copied from interface: DeclarationFormattingContext

Serialize a semicolon to a SimpleWriter.

Called after writing the property name.

Specified by:

writeSemiColon in interface DeclarationFormattingContext

Overrides:

writeSemiColon in class DefaultDeclarationFormattingContext

Parameters:

wri - the writer.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.

writeURL

public void writeURL(SimpleWriter wri,
 String href)
              throws IOException

Description copied from interface: DeclarationFormattingContext

Serialize a URL/URI to a SimpleWriter.

Specified by:

writeURL in interface DeclarationFormattingContext

Overrides:

writeURL in class DefaultDeclarationFormattingContext

Parameters:

wri - the writer.

href - the URI.

Throws:

IOException - if an I/O problem happens while writing to the SimpleWriter.