org.docgene.model

Interface StyledElement

All Known Subinterfaces:

ListElement, ParagraphElement

All Known Implementing Classes:

org.docgene.model.AbstractAPI, org.docgene.model.AbstractJustifiedElement, org.docgene.model.AbstractLink, org.docgene.model.AbstractMoreInfoRef, org.docgene.model.AbstractParagraph, org.docgene.model.AbstractStylableText, org.docgene.model.AbstractStyledElement, org.docgene.model.AbstractWikiLink, org.docgene.model.AbstractXMLAPIDoc, XMLAnchor, XMLAPIDoc, XMLAPIDocElement, XMLArchiveURL, XMLAudio, XMLBasicNote, XMLBlock, XMLBlockquote, XMLBox, XMLBreak, XMLCategoryReference, XMLChapter, XMLCitation, XMLCode, XMLComment, XMLCommentList, XMLCondition, XMLDate, XMLDiv, XMLDotNetAPI, XMLDoxygenAPI, XMLEmptyLine, XMLExtendedImage, XMLExternalLink, XMLGlossaryReference, XMLHR, XMLHTMLElement, XMLIfCondition, XMLImage, XMLInclude, XMLIncludedAPI, XMLIncludedAPIArgument, XMLIncludedAPIMember, XMLInfobox, XMLJavaAPI, XMLList, XMLListItem, XMLMailLink, XMLMap, XMLMediawikiLink, XMLMenu, XMLMessageBox, XMLMoreInfo, XMLMoreInfoRef, XMLNoteRef, XMLParagraph, XMLPre, XMLPythonAPI, XMLQtAPI, XMLRedirect, XMLReference, XMLResource, XMLSeeAlso, XMLSeeAlsoHeading, XMLSeeArticle, XMLSentence, XMLSizedTableRow, XMLSpan, XMLTab, XMLTable, XMLTableCell, XMLTableColumn, XMLTableHeader, XMLTableRow, XMLTerm, XMLTextStyle, XMLTitle, XMLTodo, XMLTodoList, XMLTree, XMLTreeItem, XMLVideo, XMLWikipediaLink, XMLWord

public interface StyledElement

Represent an element which can be included in a paragraph.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_NONE "none": Represents elements with no type.

Method Summary

Modifier and Type	Method and Description
default java.util.Set<java.lang.String>	getCustomStyles() Return the element custom classes.
default java.lang.String	getDeclaration() Return the declaration ID of the element.
default java.lang.String	getInlinedStyle() Return the element custom inline style.
default java.lang.String	getStyle() Return the style class of the element.
default boolean	hasInlinedStyle() Return true if the element has custom inline style.
default void	setCustomStyles(java.util.Set<java.lang.String> classes) Set the element custom classes.
default void	setCustomStyles(java.lang.String style) Set the element custom styles.
default void	setInlinedStyle(java.lang.String style) Set the element custom inline style.

Field Detail

TYPE_NONE

static final java.lang.String TYPE_NONE

"none": Represents elements with no type.

See Also:

Constant Field Values

Method Detail

getDeclaration

default java.lang.String getDeclaration()

Return the declaration ID of the element. Return TYPE_NONE by default.

Returns:

the declaration ID of the element

getStyle

default java.lang.String getStyle()

Return the style class of the element. Return null by default.

Returns:

the style class

setInlinedStyle

default void setInlinedStyle(java.lang.String style)

Set the element custom inline style. It correspond to the html "style" attribute.

Parameters:

style - the element custom inline style

getInlinedStyle

default java.lang.String getInlinedStyle()

Return the element custom inline style. It correspond to the html "style" attribute.

Returns:

the element custom inline style

hasInlinedStyle

default boolean hasInlinedStyle()

Return true if the element has custom inline style. It correspond to the html "style" attribute.

Returns:

true if the element has custom inline style

setCustomStyles

default void setCustomStyles(java.util.Set<java.lang.String> classes)

Set the element custom classes.

Parameters:

classes - the custom element classes

setCustomStyles

default void setCustomStyles(java.lang.String style)

Set the element custom styles.

Parameters:

style - the custom element styles

getCustomStyles

default java.util.Set<java.lang.String> getCustomStyles()

Return the element custom classes.

Returns:

the custom classes