Interface IStyle
-
public interface IStyleRepresents the design time style for a report element in the scripting environment
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancanShrink()Tests whether the section can shrink if the actual content is smaller than the design size.java.lang.StringgetBackgroundAttachment()Returns a background attachment as a string.java.lang.StringgetBackgroundColor()Get the background color.java.lang.StringgetBackgroundImage()Returns the address of the background image.java.lang.StringgetBackgroundImageType()Returns the source type of the background image.java.lang.StringgetBackGroundPositionX()Get the x position for the background.java.lang.StringgetBackGroundPositionY()Get the y position for the background.java.lang.StringgetBackgroundRepeat()Returns the pattern of the repeat for a background image.java.lang.StringgetBorderBottomColor()Get the color of the bottom side of the border.java.lang.StringgetBorderBottomStyle()Returns the style of the bottom line of the border.java.lang.StringgetBorderBottomWidth()Get the width of the bottom side of the border.java.lang.StringgetBorderLeftColor()Get the color of the left side of the border.java.lang.StringgetBorderLeftStyle()Returns the style of the left line of the border.java.lang.StringgetBorderLeftWidth()Get the width of left side of the border.java.lang.StringgetBorderRightColor()Get the color of the right side of the border.java.lang.StringgetBorderRightStyle()Returns the style of the right line of the border.java.lang.StringgetBorderRightWidth()Get the width of right side of the border.java.lang.StringgetBorderTopColor()Get the color of the top side of the border.java.lang.StringgetBorderTopStyle()Returns the style of the top line of the border.java.lang.StringgetBorderTopWidth()Get the width of the top side of the border.java.lang.StringgetColor()Get the font color.java.lang.StringgetDateTimeFormat()Returns the pattern of the date-time-format.java.lang.StringgetDateTimeFormatCategory()Returns the category of the date-time-format.java.lang.StringgetDisplay()Returns the value that specifies if a top-level element should be a block or in-line element.java.lang.StringgetFontFamily()Get the font family.java.lang.StringgetFontSize()Get the font size.java.lang.StringgetFontStyle()Returns the style of the font.java.lang.StringgetFontVariant()Returns the variant of the font.java.lang.StringgetFontWeight()Get the weight of the font.java.lang.StringgetHeight()Returns the value of height property.java.lang.StringgetLetterSpacing()Get the spacing between individual letters.java.lang.StringgetLineHeight()Get the height of a line.java.lang.StringgetMarginBottom()Get the margin of the bottom side.java.lang.StringgetMarginLeft()Get the margin of the left side.java.lang.StringgetMarginRight()Get the margin of the right side.java.lang.StringgetMarginTop()Get the margin of the top side.java.lang.StringgetMasterPage()Returns the name of the master page on which to start this section.java.lang.StringgetNumberFormat()Returns the pattern of a number format for a style.java.lang.StringgetNumberFormatCategory()Returns the category of a number format for a style.java.lang.StringgetOrphans()Returns the value of orphans.java.lang.StringgetOverflow()Returns the value of overflow property.java.lang.StringgetPaddingBottom()Get the padding of the bottom side.java.lang.StringgetPaddingLeft()Get the padding of the left side.java.lang.StringgetPaddingRight()Get the padding of the right side.java.lang.StringgetPaddingTop()Get the padding of the top side.java.lang.StringgetPageBreakAfter()Returns the page break after property for block-level elements.java.lang.StringgetPageBreakBefore()Returns the page break before property for block-level elements.java.lang.StringgetPageBreakInside()Returns the page break inside property for block-level elements.booleangetShowIfBlank()Tests whether to show this frame even if it is empty, or all its data elements are empty.java.lang.StringgetStringFormat()Returns the pattern of a string format.java.lang.StringgetStringFormatCategory()Returns the category of a string format.java.lang.StringgetTextAlign()Returns the text align for block-level elements.java.lang.StringgetTextDirection()Returns the value of direction property.java.lang.StringgetTextIndent()Get the text indent.java.lang.StringgetTextLineThrough()Returns one 'text-decoration' property to set line-through styles.java.lang.StringgetTextOverline()Returns one 'text-decoration' property to set overline styles.java.lang.StringgetTextTransform()Returns the value to transform the text.java.lang.StringgetTextUnderline()Returns one 'text-decoration' property to set underline styles.java.lang.StringgetVerticalAlign()Returns the value of the vertical align property for inline elements.java.lang.StringgetWhiteSpace()Returns the white space for block elements.java.lang.StringgetWidows()Returns the value of widows.java.lang.StringgetWidth()Returns the value of width property.java.lang.StringgetWordSpacing()Get the spacing between two words.voidsetBackgroundAttachment(java.lang.String value)Sets the background attachment.voidsetBackgroundColor(java.lang.String color)Set the background color.voidsetBackgroundImage(java.lang.String value)Sets the address of the background image.voidsetBackgroundImageType(java.lang.String value)Sets the source type of the background image.voidsetBackGroundPositionX(java.lang.String x)Set the x position for the background.voidsetBackGroundPositionY(java.lang.String y)Set the y position for the background.voidsetBackgroundRepeat(java.lang.String value)Sets the repeat pattern for a background image.voidsetBorderBottomColor(java.lang.String color)Set the color of the bottom side of the border.voidsetBorderBottomStyle(java.lang.String value)Sets the style of the bottom line of the border.voidsetBorderBottomWidth(java.lang.String width)Set the width of the bottom side of the border.voidsetBorderLeftColor(java.lang.String color)Set the color of the left side of the border.voidsetBorderLeftStyle(java.lang.String value)Sets the style of the left line of the border.voidsetBorderLeftWidth(java.lang.String width)Set the width of left side of the border.voidsetBorderRightColor(java.lang.String color)Set the color of the right side of the border.voidsetBorderRightStyle(java.lang.String value)Sets the style of the right line of the border.voidsetBorderRightWidth(java.lang.String width)Set the width of the right side of the border.voidsetBorderTopColor(java.lang.String color)Set the color of the top side of the border.voidsetBorderTopStyle(java.lang.String value)Sets the style of the top line of the border.voidsetBorderTopWidth(java.lang.String width)Set the width of the top side of the border.voidsetCanShrink(boolean value)Sets whether the section can shrink if the actual content is smaller than the design size.voidsetColor(java.lang.String color)Set the font color.voidsetDateTimeFormat(java.lang.String pattern)Sets the pattern of a date time format for a highlight rule.voidsetDateTimeFormatCategory(java.lang.String pattern)Sets the category of a number format.voidsetDisplay(java.lang.String value)Sets the value that specifies if a top-level element should be a block or in-line element.voidsetFontFamily(java.lang.String fontFamily)Set the font family.voidsetFontSize(java.lang.String fontSize)Set the font size.voidsetFontStyle(java.lang.String fontStyle)Sets the style of the font.voidsetFontVariant(java.lang.String fontVariant)Sets the variant of the font.voidsetFontWeight(java.lang.String fontWeight)Sets the weight of the font.voidsetHeight(java.lang.String height)Sets the value of height property.voidsetLetterSpacing(java.lang.String spacing)Set the spacing between individual letters.voidsetLineHeight(java.lang.String height)Set the height of a line.voidsetMarginBottom(java.lang.String margin)Set the margin of the bottom side.voidsetMarginLeft(java.lang.String margin)Set the margin of the left side.voidsetMarginRight(java.lang.String margin)Set the margin of the right side.voidsetMarginTop(java.lang.String margin)Set the margin of the top side.voidsetMasterPage(java.lang.String value)Sets the master page name on which to start this section.voidsetNumberFormat(java.lang.String pattern)Sets the pattern of a number format.voidsetNumberFormatCategory(java.lang.String category)Sets the category of a number format for a highlight rule.voidsetOrphans(java.lang.String value)Sets the orphans property.voidsetOverflow(java.lang.String value)Sets the value of overflow property.voidsetPaddingBottom(java.lang.String padding)Set the padding of the bottom side.voidsetPaddingLeft(java.lang.String padding)Set the padding of the left side.voidsetPaddingRight(java.lang.String padding)Set the padding of the right side.voidsetPaddingTop(java.lang.String padding)Set the padding of the top side.voidsetPageBreakAfter(java.lang.String value)Sets the page break after property for block-level elements.voidsetPageBreakBefore(java.lang.String value)Sets the page break before property for block-level elements.voidsetPageBreakInside(java.lang.String value)Sets the page break inside property for block-level elements.voidsetShowIfBlank(boolean value)Sets whether to show this frame even if it is empty, or all its data elements are empty.voidsetStringFormat(java.lang.String pattern)Sets the pattern of a string format.voidsetStringFormatCategory(java.lang.String pattern)Sets the category of a string format.voidsetTextAlign(java.lang.String value)Sets the text align for block-level elements.voidsetTextDirection(java.lang.String value)Sets the Bidi direction property.voidsetTextIndent(java.lang.String indent)Set the text indent.voidsetTextLineThrough(java.lang.String value)Sets one 'text-decoration' property to set line-through styles.voidsetTextOverline(java.lang.String value)Sets one 'text-decoration' property to set overline styles.voidsetTextTransform(java.lang.String value)Sets the value used to transform the text.voidsetTextUnderline(java.lang.String value)Sets one 'text-decoration' property to set underline styles.voidsetVerticalAlign(java.lang.String value)Sets the value of the vertical align property for inline elements.voidsetWhiteSpace(java.lang.String value)Sets the white space property for block elements.voidsetWidows(java.lang.String value)Sets the widows property.voidsetWidth(java.lang.String width)Sets the value of width property.voidsetWordSpacing(java.lang.String spacing)Set the spacing between two words.
-
-
-
Method Detail
-
getBackgroundAttachment
java.lang.String getBackgroundAttachment()
Returns a background attachment as a string. The return value is defined inDesignChoiceConstantsand can be one of:- BACKGROUND_ATTACHMENT_SCROLL
- BACKGROUND_ATTACHMENT_FIXED
- Returns:
- the background attachment
-
setBackgroundAttachment
void setBackgroundAttachment(java.lang.String value) throws SemanticExceptionSets the background attachment. The return value is defined inDesignChoiceConstantsand can be one of:- BACKGROUND_ATTACHMENT_SCROLL
- BACKGROUND_ATTACHMENT_FIXED
- Parameters:
value- the new background attachment- Throws:
SemanticException- if the value is not one of the above.
-
getBackgroundImage
java.lang.String getBackgroundImage()
Returns the address of the background image.- Returns:
- the address of the background image as a string
-
setBackgroundImage
void setBackgroundImage(java.lang.String value) throws SemanticExceptionSets the address of the background image. The value is a URL as a string.- Parameters:
value- the new background image address- Throws:
SemanticException- if the property is locked
-
getBackgroundImageType
java.lang.String getBackgroundImageType()
Returns the source type of the background image.- Returns:
- the source type of the background image as a string
-
setBackgroundImageType
void setBackgroundImageType(java.lang.String value) throws SemanticExceptionSets the source type of the background image. The value is a "url" or "embed".- Parameters:
value- the new background image type- Throws:
SemanticException- if the property is locked
-
getBackgroundRepeat
java.lang.String getBackgroundRepeat()
Returns the pattern of the repeat for a background image. The return value is defined inDesignChoiceConstantsand can be one of:- BACKGROUND_REPEAT_REPEAT
- BACKGROUND_REPEAT_REPEAT_X
- BACKGROUND_REPEAT_REPEAT_Y
- BACKGROUND_REPEAT_NO_REPEAT
- Returns:
- the repeat pattern
-
setBackgroundRepeat
void setBackgroundRepeat(java.lang.String value) throws SemanticExceptionSets the repeat pattern for a background image. The input value is defined inDesignChoiceConstantsand can be one of:- BACKGROUND_REPEAT_REPEAT
- BACKGROUND_REPEAT_REPEAT_X
- BACKGROUND_REPEAT_REPEAT_Y
- BACKGROUND_REPEAT_NO_REPEAT
- Parameters:
value- the new repeat pattern- Throws:
SemanticException- if the value is not one of the above.
-
getBorderBottomStyle
java.lang.String getBorderBottomStyle()
Returns the style of the bottom line of the border. The return value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the style of the bottom line
-
setBorderBottomStyle
void setBorderBottomStyle(java.lang.String value) throws SemanticExceptionSets the style of the bottom line of the border. The input value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Parameters:
value- the new style of the bottom line- Throws:
SemanticException- if the value is not one of the above.
-
getBorderLeftStyle
java.lang.String getBorderLeftStyle()
Returns the style of the left line of the border. The return value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the style of the left line
-
setBorderLeftStyle
void setBorderLeftStyle(java.lang.String value) throws SemanticExceptionSets the style of the left line of the border. The input value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Parameters:
value- the new style of the left line- Throws:
SemanticException- if the value is not one of the above.
-
getBorderRightStyle
java.lang.String getBorderRightStyle()
Returns the style of the right line of the border. The return value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the style of the right line
-
setBorderRightStyle
void setBorderRightStyle(java.lang.String value) throws SemanticExceptionSets the style of the right line of the border. The input value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Parameters:
value- the new style of the right line- Throws:
SemanticException- if the value is not one of the above.
-
getBorderTopStyle
java.lang.String getBorderTopStyle()
Returns the style of the top line of the border. The return value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Returns:
- the style of the top line
-
setBorderTopStyle
void setBorderTopStyle(java.lang.String value) throws SemanticExceptionSets the style of the top line of the border. The input value is defined inDesignChoiceConstantsand can be one of:LINE_STYLE_NONELINE_STYLE_SOLIDLINE_STYLE_DOTTEDLINE_STYLE_DASHEDLINE_STYLE_DOUBLELINE_STYLE_GROOVELINE_STYLE_RIDGELINE_STYLE_INSETLINE_STYLE_OUTSET
- Parameters:
value- the new style of the right line- Throws:
SemanticException- if the value is not one of the above.
-
canShrink
boolean canShrink()
Tests whether the section can shrink if the actual content is smaller than the design size.- Returns:
trueif can shrink, otherwisefalse- See Also:
setCanShrink(boolean)
-
setCanShrink
void setCanShrink(boolean value) throws SemanticExceptionSets whether the section can shrink if the actual content is smaller than the design size.- Parameters:
value-trueif can shrink,falsenot.- Throws:
SemanticException- if the property is locked- See Also:
canShrink()
-
getStringFormat
java.lang.String getStringFormat()
Returns the pattern of a string format.- Returns:
- the pattern of a string format
-
setStringFormat
void setStringFormat(java.lang.String pattern) throws SemanticExceptionSets the pattern of a string format.- Parameters:
pattern- the pattern of a string forma- Throws:
SemanticException- if the property is locked
-
getStringFormatCategory
java.lang.String getStringFormatCategory()
Returns the category of a string format.- Returns:
- the category of a string format
-
setStringFormatCategory
void setStringFormatCategory(java.lang.String pattern) throws SemanticExceptionSets the category of a string format. Thepatterncan be one of:DesignChoiceConstants.STRING_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.STRING_FORMAT_TYPE_UPPERCASEDesignChoiceConstants.STRING_FORMAT_TYPE_LOWERCASEDesignChoiceConstants.STRING_FORMAT_TYPE_CUSTOMDesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODEDesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE_4DesignChoiceConstants.STRING_FORMAT_TYPE_PHONE_NUMBER-
DesignChoiceConstants.STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
- Parameters:
pattern- the category of a string format- Throws:
SemanticException- ifpatternis not one of the above values.
-
getNumberFormat
java.lang.String getNumberFormat()
Returns the pattern of a number format for a style.- Returns:
- the pattern of a number format
-
setNumberFormat
void setNumberFormat(java.lang.String pattern) throws SemanticExceptionSets the pattern of a number format.- Parameters:
pattern- the pattern of a number format- Throws:
SemanticException- if the property is locked
-
getNumberFormatCategory
java.lang.String getNumberFormatCategory()
Returns the category of a number format for a style.- Returns:
- the category of a number format
-
setNumberFormatCategory
void setNumberFormatCategory(java.lang.String category) throws SemanticExceptionSets the category of a number format for a highlight rule. Thepatterncan be one of:DesignChoiceConstants.NUMBER_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.NUMBER_FORMAT_TYPE_GENERAL_NUMBERDesignChoiceConstants.NUMBER_FORMAT_TYPE_CURRENCYDesignChoiceConstants.NUMBER_FORMAT_TYPE_FIXEDDesignChoiceConstants.NUMBER_FORMAT_TYPE_PERCENTDesignChoiceConstants.NUMBER_FORMAT_TYPE_SCIENTIFICDesignChoiceConstants.NUMBER_FORMAT_TYPE_STANDARDDesignChoiceConstants.NUMBER_FORMAT_TYPE_CUSTOM
- Parameters:
category- the category of a number format- Throws:
SemanticException- ifcategoryis not one of the above values.
-
getDateTimeFormat
java.lang.String getDateTimeFormat()
Returns the pattern of the date-time-format.- Returns:
- the pattern of the date-time-format
-
setDateTimeFormat
void setDateTimeFormat(java.lang.String pattern) throws SemanticExceptionSets the pattern of a date time format for a highlight rule.- Parameters:
pattern- the pattern of a date time format- Throws:
SemanticException- if the property is locked
-
getDateTimeFormatCategory
java.lang.String getDateTimeFormatCategory()
Returns the category of the date-time-format.- Returns:
- the category of the date-time-format
-
setDateTimeFormatCategory
void setDateTimeFormatCategory(java.lang.String pattern) throws SemanticExceptionSets the category of a number format. Thepatterncan be one of:DesignChoiceConstants.DATETIEM_FORMAT_TYPE_UNFORMATTEDDesignChoiceConstants.DATETIEM_FORMAT_TYPE_GENERAL_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_MUDIUM_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_DATEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_MEDIUM_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_TIMEDesignChoiceConstants.DATETIEM_FORMAT_TYPE_CUSTOM
- Parameters:
pattern- the category of a date-time format- Throws:
SemanticException- ifpatternis not one of the above values.
-
getDisplay
java.lang.String getDisplay()
Returns the value that specifies if a top-level element should be a block or in-line element. The input value is defined inDesignChoiceConstantsand can be one of:DISPLAY_NONEDISPLAY_INLINEDISPLAY_BLOCK
- Returns:
- the display value as a string
-
setDisplay
void setDisplay(java.lang.String value) throws SemanticExceptionSets the value that specifies if a top-level element should be a block or in-line element. The input value is defined inDesignChoiceConstantsand can be one of:DISPLAY_NONEDISPLAY_INLINEDISPLAY_BLOCK
- Parameters:
value- the new display value- Throws:
SemanticException- if the value is not one of the above.
-
getMasterPage
java.lang.String getMasterPage()
Returns the name of the master page on which to start this section.- Returns:
- the master page name
- See Also:
setMasterPage(String)
-
setMasterPage
void setMasterPage(java.lang.String value) throws SemanticExceptionSets the master page name on which to start this section. If blank, the normal page sequence is used. If defined, the section starts on a new page, and the master page is the one defined here. The subsequent pages are those defined by the report's page sequence.- Parameters:
value- the new master page name- Throws:
SemanticException- if the property is locked- See Also:
getMasterPage()
-
getOrphans
java.lang.String getOrphans()
Returns the value of orphans. The return value is either an integer as as string or one of constants defined inDesignChoiceConstants:ORPHANS_INHERIT
- Returns:
- the orphans property
- See Also:
setOrphans(String)
-
setOrphans
void setOrphans(java.lang.String value) throws SemanticExceptionSets the orphans property. A orphan occurs if the first line of a multi-line paragraph appears on its own at the bottom of a page due to a page break. The input value is either an integer as as string or one of constants defined inDesignChoiceConstants:ORPHANS_INHERIT
- Parameters:
value- the new orphans property- Throws:
SemanticException- if the value is not an integer or one of the above constants.- See Also:
getOrphans()
-
getPageBreakAfter
java.lang.String getPageBreakAfter()
Returns the page break after property for block-level elements. The return value is one of constants defined inDesignChoiceConstants:PAGE_BREAK_AUTOPAGE_BREAK_ALWAYSPAGE_BREAK_AVOIDPAGE_BREAK_LEFTPAGE_BREAK_RIGHTPAGE_BREAK_INHERIT
- Returns:
- the page break after property
-
setPageBreakAfter
void setPageBreakAfter(java.lang.String value) throws SemanticExceptionSets the page break after property for block-level elements. The input value is one of constants defined inDesignChoiceConstants:PAGE_BREAK_AUTOPAGE_BREAK_ALWAYSPAGE_BREAK_AVOIDPAGE_BREAK_LEFTPAGE_BREAK_RIGHTPAGE_BREAK_INHERIT
- Parameters:
value- the new page break after property- Throws:
SemanticException- if the value is not pre-defined.
-
getPageBreakBefore
java.lang.String getPageBreakBefore()
Returns the page break before property for block-level elements. The return value is one of constants defined inDesignChoiceConstants:PAGE_BREAK_AUTOPAGE_BREAK_ALWAYSPAGE_BREAK_AVOIDPAGE_BREAK_LEFTPAGE_BREAK_RIGHTPAGE_BREAK_INHERIT
- Returns:
- the page break before property
-
setPageBreakBefore
void setPageBreakBefore(java.lang.String value) throws SemanticExceptionSets the page break before property for block-level elements. The return value is one of constants defined inDesignChoiceConstants:PAGE_BREAK_AUTOPAGE_BREAK_ALWAYSPAGE_BREAK_AVOIDPAGE_BREAK_LEFTPAGE_BREAK_RIGHTPAGE_BREAK_INHERIT
- Parameters:
value- the new page break before property- Throws:
SemanticException- if the value is not one of the above.
-
getPageBreakInside
java.lang.String getPageBreakInside()
Returns the page break inside property for block-level elements. The return value is one of constants defined inDesignChoiceConstants:PAGEBREAK_INSIDE_AVOIDPAGEBREAK_INSIDE_AUTOPAGEBREAK_INSIDE_INHERIT
- Returns:
- the page break inside property
-
setPageBreakInside
void setPageBreakInside(java.lang.String value) throws SemanticExceptionSets the page break inside property for block-level elements. The input value is one of constants defined inDesignChoiceConstants:PAGEBREAK_INSIDE_AVOIDPAGEBREAK_INSIDE_AUTOPAGEBREAK_INSIDE_INHERIT
- Parameters:
value- the new page break inside property- Throws:
SemanticException- if the value is not one of the above.
-
getShowIfBlank
boolean getShowIfBlank()
Tests whether to show this frame even if it is empty, or all its data elements are empty. Iffalse, the section is automatically hidden when empty.- Returns:
trueif show-if-blank, otherwisefalse- See Also:
setShowIfBlank(boolean)
-
setShowIfBlank
void setShowIfBlank(boolean value) throws SemanticExceptionSets whether to show this frame even if it is empty, or all its data elements are empty.- Parameters:
value-trueif show the frame.falsenot.- Throws:
SemanticException- if the property is locked- See Also:
getShowIfBlank()
-
getTextUnderline
java.lang.String getTextUnderline()
Returns one 'text-decoration' property to set underline styles. The return value is one of constants defined inDesignChoiceConstants:TEXT_UNDERLINE_NONETEXT_UNDERLINE_UNDERLINE
- Returns:
- the text underline value
-
setTextUnderline
void setTextUnderline(java.lang.String value) throws SemanticExceptionSets one 'text-decoration' property to set underline styles. The input value is one of constants defined inDesignChoiceConstants:TEXT_UNDERLINE_NONETEXT_UNDERLINE_UNDERLINE
- Parameters:
value- the new text underline- Throws:
SemanticException- if the value is not pre-defined.
-
getTextOverline
java.lang.String getTextOverline()
Returns one 'text-decoration' property to set overline styles. The return value is one of constants defined inDesignChoiceConstants:TEXT_OVERLINE_NONETEXT_OVERLINE_OVERLINE
- Returns:
- the text overline value
-
setTextOverline
void setTextOverline(java.lang.String value) throws SemanticExceptionSets one 'text-decoration' property to set overline styles. The input value is one of constants defined inDesignChoiceConstants:TEXT_OVERLINE_NONETEXT_OVERLINE_OVERLINE
- Parameters:
value- the new text overline value- Throws:
SemanticException- if the value is not one of the above.
-
getTextLineThrough
java.lang.String getTextLineThrough()
Returns one 'text-decoration' property to set line-through styles. The return value is one of constants defined inDesignChoiceConstants:TEXT_LINE_THROUGH_NONETEXT_LINE_THROUGH_LINE_THROUGH
- Returns:
- the text line-through value
-
setTextLineThrough
void setTextLineThrough(java.lang.String value) throws SemanticExceptionSets one 'text-decoration' property to set line-through styles. The input value is one of constants defined inDesignChoiceConstants:TEXT_LINE_THROUGH_NONETEXT_LINE_THROUGH_LINE_THROUGH
- Parameters:
value- the new text line-through value- Throws:
SemanticException- if the value is not one of the above.
-
getTextAlign
java.lang.String getTextAlign()
Returns the text align for block-level elements. The return value is one of constants defined inDesignChoiceConstants:TEXT_ALIGN_LEFTTEXT_ALIGN_CENTERTEXT_ALIGN_RIGHTTEXT_ALIGN_JUSTIFY
- Returns:
- the text align value
-
setTextAlign
void setTextAlign(java.lang.String value) throws SemanticExceptionSets the text align for block-level elements. The input value is one of constants defined inDesignChoiceConstants:TEXT_ALIGN_LEFTTEXT_ALIGN_CENTERTEXT_ALIGN_RIGHTTEXT_ALIGN_JUSTIFY
- Parameters:
value- the new text align- Throws:
SemanticException- if the value is not one of the above.
-
getTextTransform
java.lang.String getTextTransform()
Returns the value to transform the text. The return value is one of constants defined inDesignChoiceConstants:TRANSFORM_CAPITALIZETRANSFORM_UPPERCASETRANSFORM_LOWERCASETRANSFORM_NONE
- Returns:
- the text transform
-
setTextTransform
void setTextTransform(java.lang.String value) throws SemanticExceptionSets the value used to transform the text. The input value is one of constants defined inDesignChoiceConstants:TRANSFORM_CAPITALIZETRANSFORM_UPPERCASETRANSFORM_LOWERCASETRANSFORM_NONE
- Parameters:
value- the new text transform- Throws:
SemanticException- if the value is not one of the above.
-
getVerticalAlign
java.lang.String getVerticalAlign()
Returns the value of the vertical align property for inline elements. The return value is defined inDesignChoiceConstantsand can be one of:- VERTICAL_ALIGN_BASELINE
- VERTICAL_ALIGN_SUB
- VERTICAL_ALIGN_SUPER
- VERTICAL_ALIGN_TOP
- VERTICAL_ALIGN_TEXT_TOP
- VERTICAL_ALIGN_MIDDLE
- VERTICAL_ALIGN_BOTTOM
- VERTICAL_ALIGN_TEXT_BOTTOM
- Returns:
- the value of the vertical align property
-
setVerticalAlign
void setVerticalAlign(java.lang.String value) throws SemanticExceptionSets the value of the vertical align property for inline elements. The input value is defined inDesignChoiceConstantsand can be one of:- VERTICAL_ALIGN_BASELINE
- VERTICAL_ALIGN_SUB
- VERTICAL_ALIGN_SUPER
- VERTICAL_ALIGN_TOP
- VERTICAL_ALIGN_TEXT_TOP
- VERTICAL_ALIGN_MIDDLE
- VERTICAL_ALIGN_BOTTOM
- VERTICAL_ALIGN_TEXT_BOTTOM
- Parameters:
value- the new vertical align- Throws:
SemanticException- if the value is not one of the above.
-
getWhiteSpace
java.lang.String getWhiteSpace()
Returns the white space for block elements. The return value is defined inDesignChoiceConstantsand can be one of:WHITE_SPACE_NORMALWHITE_SPACE_PREWHITE_SPACE_NOWRAP
- Returns:
- the white space
-
setWhiteSpace
void setWhiteSpace(java.lang.String value) throws SemanticExceptionSets the white space property for block elements. The return value is defined inDesignChoiceConstantsand can be one of:WHITE_SPACE_NORMALWHITE_SPACE_PREWHITE_SPACE_NOWRAP
- Parameters:
value- the new white space- Throws:
SemanticException- if the value is not one of the above.
-
getWidows
java.lang.String getWidows()
Returns the value of widows. The return value is either an integer as as string or one of constants defined inDesignChoiceConstants:WIDOWS_INHERIT
- Returns:
- the widows property
- See Also:
setWidows(String)
-
setWidows
void setWidows(java.lang.String value) throws SemanticExceptionSets the widows property. A 'widow' occurs when the last line of a multi-line paragraph appears on its own at the top of a page due to a page break. The input value is either an integer as as string or one of constants defined inDesignChoiceConstants:WIDOWS_INHERIT
- Parameters:
value- the new windows property- Throws:
SemanticException- if the value is not an integer or one of the above constants.- See Also:
getWidows()
-
getColor
java.lang.String getColor()
Get the font color.- Returns:
- color
-
setColor
void setColor(java.lang.String color) throws SemanticExceptionSet the font color.- Parameters:
color-- Throws:
SemanticException
-
getBackgroundColor
java.lang.String getBackgroundColor()
Get the background color.- Returns:
- background color
-
setBackgroundColor
void setBackgroundColor(java.lang.String color) throws SemanticExceptionSet the background color.- Parameters:
color-- Throws:
SemanticException
-
getBorderTopColor
java.lang.String getBorderTopColor()
Get the color of the top side of the border.- Returns:
- color of top border
-
setBorderTopColor
void setBorderTopColor(java.lang.String color) throws SemanticExceptionSet the color of the top side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderLeftColor
java.lang.String getBorderLeftColor()
Get the color of the left side of the border.- Returns:
- color of left side of border
-
setBorderLeftColor
void setBorderLeftColor(java.lang.String color) throws SemanticExceptionSet the color of the left side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderRightColor
java.lang.String getBorderRightColor()
Get the color of the right side of the border.- Returns:
- color of right side of border
-
setBorderRightColor
void setBorderRightColor(java.lang.String color) throws SemanticExceptionSet the color of the right side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderBottomColor
java.lang.String getBorderBottomColor()
Get the color of the bottom side of the border.- Returns:
- color of bottom side of border
-
setBorderBottomColor
void setBorderBottomColor(java.lang.String color) throws SemanticExceptionSet the color of the bottom side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBackGroundPositionX
java.lang.String getBackGroundPositionX()
Get the x position for the background.- Returns:
- x position
-
setBackGroundPositionX
void setBackGroundPositionX(java.lang.String x) throws SemanticExceptionSet the x position for the background.- Parameters:
x-- Throws:
SemanticException
-
getBackGroundPositionY
java.lang.String getBackGroundPositionY()
Get the y position for the background.- Returns:
- y position
-
setBackGroundPositionY
void setBackGroundPositionY(java.lang.String y) throws SemanticExceptionSet the y position for the background.- Parameters:
y-- Throws:
SemanticException
-
getLetterSpacing
java.lang.String getLetterSpacing()
Get the spacing between individual letters.- Returns:
- spacing
-
setLetterSpacing
void setLetterSpacing(java.lang.String spacing) throws SemanticExceptionSet the spacing between individual letters.- Parameters:
spacing-- Throws:
SemanticException
-
getLineHeight
java.lang.String getLineHeight()
Get the height of a line. Implies spacing between lines.- Returns:
- height of a line
-
setLineHeight
void setLineHeight(java.lang.String height) throws SemanticExceptionSet the height of a line. Implies spacing between lines.- Parameters:
height-- Throws:
SemanticException
-
getTextIndent
java.lang.String getTextIndent()
Get the text indent.- Returns:
- text indent
-
setTextIndent
void setTextIndent(java.lang.String indent) throws SemanticExceptionSet the text indent.- Parameters:
indent-- Throws:
SemanticException
-
getWordSpacing
java.lang.String getWordSpacing()
Get the spacing between two words.- Returns:
- spacing
-
setWordSpacing
void setWordSpacing(java.lang.String spacing) throws SemanticExceptionSet the spacing between two words.- Parameters:
spacing-- Throws:
SemanticException
-
getBorderTopWidth
java.lang.String getBorderTopWidth()
Get the width of the top side of the border.- Returns:
- width of top side of border
-
setBorderTopWidth
void setBorderTopWidth(java.lang.String width) throws SemanticExceptionSet the width of the top side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderLeftWidth
java.lang.String getBorderLeftWidth()
Get the width of left side of the border.- Returns:
- width of left side of border
-
setBorderLeftWidth
void setBorderLeftWidth(java.lang.String width) throws SemanticExceptionSet the width of left side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderRightWidth
java.lang.String getBorderRightWidth()
Get the width of right side of the border.- Returns:
- width of right side of border
-
setBorderRightWidth
void setBorderRightWidth(java.lang.String width) throws SemanticExceptionSet the width of the right side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderBottomWidth
java.lang.String getBorderBottomWidth()
Get the width of the bottom side of the border.- Returns:
- width of bottom side of border
-
setBorderBottomWidth
void setBorderBottomWidth(java.lang.String width) throws SemanticExceptionSet the width of the bottom side of the border.- Parameters:
width-- Throws:
SemanticException
-
getMarginTop
java.lang.String getMarginTop()
Get the margin of the top side.- Returns:
- margin of top side.
-
setMarginTop
void setMarginTop(java.lang.String margin) throws SemanticExceptionSet the margin of the top side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginRight
java.lang.String getMarginRight()
Get the margin of the right side.- Returns:
- margin of right side
-
setMarginRight
void setMarginRight(java.lang.String margin) throws SemanticExceptionSet the margin of the right side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginLeft
java.lang.String getMarginLeft()
Get the margin of the left side.- Returns:
- margin of left side
-
setMarginLeft
void setMarginLeft(java.lang.String margin) throws SemanticExceptionSet the margin of the left side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginBottom
java.lang.String getMarginBottom()
Get the margin of the bottom side.- Returns:
- margin of bottom side
-
setMarginBottom
void setMarginBottom(java.lang.String margin) throws SemanticExceptionSet the margin of the bottom side.- Parameters:
margin-- Throws:
SemanticException
-
getPaddingTop
java.lang.String getPaddingTop()
Get the padding of the top side.- Returns:
- padding of top side
-
setPaddingTop
void setPaddingTop(java.lang.String padding) throws SemanticExceptionSet the padding of the top side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingRight
java.lang.String getPaddingRight()
Get the padding of the right side.- Returns:
- padding of right side
-
setPaddingRight
void setPaddingRight(java.lang.String padding) throws SemanticExceptionSet the padding of the right side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingLeft
java.lang.String getPaddingLeft()
Get the padding of the left side.- Returns:
- padding of left side
-
setPaddingLeft
void setPaddingLeft(java.lang.String padding) throws SemanticExceptionSet the padding of the left side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingBottom
java.lang.String getPaddingBottom()
Get the padding of the bottom side.- Returns:
- padding of bottom side
-
setPaddingBottom
void setPaddingBottom(java.lang.String padding) throws SemanticExceptionSet the padding of the bottom side.- Parameters:
padding-- Throws:
SemanticException
-
getFontSize
java.lang.String getFontSize()
Get the font size.- Returns:
- font size
-
setFontSize
void setFontSize(java.lang.String fontSize) throws SemanticExceptionSet the font size.- Parameters:
fontSize-- Throws:
SemanticException
-
getFontFamily
java.lang.String getFontFamily()
Get the font family.- Returns:
- font family
-
setFontFamily
void setFontFamily(java.lang.String fontFamily) throws SemanticExceptionSet the font family.- Parameters:
fontFamily-- Throws:
SemanticException
-
getFontWeight
java.lang.String getFontWeight()
Get the weight of the font.- Returns:
- weight of font
-
setFontWeight
void setFontWeight(java.lang.String fontWeight) throws SemanticExceptionSets the weight of the font. The input value is one of constants defined inDesignChoiceConstants:FONT_WEIGHT_NORMALFONT_WEIGHT_BOLDFONT_WEIGHT_BOLDERFONT_WEIGHT_LIGHTERFONT_WEIGHT_100FONT_WEIGHT_200FONT_WEIGHT_300FONT_WEIGHT_400FONT_WEIGHT_500FONT_WEIGHT_600FONT_WEIGHT_700FONT_WEIGHT_800FONT_WEIGHT_900
- Parameters:
fontWeight- the new font weight- Throws:
SemanticException- if the input value is not one of the above.
-
getFontVariant
java.lang.String getFontVariant()
Returns the variant of the font. The return value is one of constants defined inDesignChoiceConstants:FONT_VARIANT_NORMALFONT_VARIANT_SMALL_CAPS
- Returns:
- the font variant in a string.
-
setFontVariant
void setFontVariant(java.lang.String fontVariant) throws SemanticExceptionSets the variant of the font. The input value is one of constants defined inDesignChoiceConstants:FONT_VARIANT_NORMALFONT_VARIANT_SMALL_CAPS
- Parameters:
fontVariant- the new font variant.- Throws:
SemanticException- if the input value is not one of the above.
-
getFontStyle
java.lang.String getFontStyle()
Returns the style of the font. The return value is one of constants defined inDesignChoiceConstants:FONT_STYLE_NORMALFONT_STYLE_ITALICFONT_STYLE_OBLIQUE
- Returns:
- the font style in string.
-
setFontStyle
void setFontStyle(java.lang.String fontStyle) throws SemanticExceptionSets the style of the font. The input value is one of constants defined inDesignChoiceConstants:FONT_STYLE_NORMALFONT_STYLE_ITALICFONT_STYLE_OBLIQUE
- Parameters:
fontStyle- the new font style.- Throws:
SemanticException- if the input value is not one of the above.
-
getTextDirection
java.lang.String getTextDirection()
Returns the value of direction property. The return value is defined inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Returns:
- the value of direction property
-
setTextDirection
void setTextDirection(java.lang.String value) throws SemanticExceptionSets the Bidi direction property. The input value is defined inDesignChoiceConstantsand can be one of:BIDI_DIRECTION_LTRBIDI_DIRECTION_RTL
- Parameters:
value- the new direction value- Throws:
SemanticException- if the value is not one of the above.
-
getOverflow
java.lang.String getOverflow()
Returns the value of overflow property. The return value is defined inDesignChoiceConstantsand can be one of:OVERFLOW_AUTOOVERFLOW_HIDDENOVERFLOW_SCROLLOVERFLOW_VISIBLE
- Returns:
- the value of overflow property.
-
setOverflow
void setOverflow(java.lang.String value) throws SemanticExceptionSets the value of overflow property. The input value is defined inDesignChoiceConstantsand can be one of:OVERFLOW_AUTOOVERFLOW_HIDDENOVERFLOW_SCROLLOVERFLOW_VISIBLE
- Parameters:
value- the new overflow value- Throws:
SemanticException
-
getHeight
java.lang.String getHeight()
Returns the value of height property.- Returns:
- the value of height property.
-
setHeight
void setHeight(java.lang.String height) throws SemanticExceptionSets the value of height property.- Parameters:
height- the new height value- Throws:
SemanticException
-
getWidth
java.lang.String getWidth()
Returns the value of width property.- Returns:
- the value of width property.
-
setWidth
void setWidth(java.lang.String width) throws SemanticExceptionSets the value of width property.- Parameters:
width- the new width value- Throws:
SemanticException
-
-