Interface IStyle
public interface IStyle
Represents the design time style for a report element in the scripting
environment
-
Method Summary
Modifier and TypeMethodDescriptionbooleanTests whether the section can shrink if the actual content is smaller than the design size.Returns a background attachment as a string.Get the background color.Returns the height of the background image.Returns the address of the background image.Returns the source type of the background image.Get the x position for the background.Get the y position for the background.Returns the pattern of the repeat for a background image.Returns the width of the background image.Get the color of the bottom side of the border.Returns the style of the bottom line of the border.Get the width of the bottom side of the border.Get the color of the left side of the border.Returns the style of the left line of the border.Get the width of left side of the border.Get the color of the right side of the border.Returns the style of the right line of the border.Get the width of right side of the border.Get the color of the top side of the border.Returns the style of the top line of the border.Get the width of the top side of the border.getColor()Get the font color.Returns the pattern of the date-time-format.Returns the category of the date-time-format.Returns the value that specifies if a top-level element should be a block or in-line element.Get the font family.Get the font size.Returns the style of the font.Returns the variant of the font.Get the weight of the font.Returns the value of height property.Get the spacing between individual letters.Get the height of a line.Get the margin of the bottom side.Get the margin of the left side.Get the margin of the right side.Get the margin of the top side.Returns the name of the master page on which to start this section.Returns the pattern of a number format for a style.Returns the category of a number format for a style.Returns the value of orphans.Returns the value of overflow property.Get the padding of the bottom side.Get the padding of the left side.Get the padding of the right side.Get the padding of the top side.Returns the page break after property for block-level elements.Returns the page break before property for block-level elements.Returns the page break inside property for block-level elements.booleanTests whether to show this frame even if it is empty, or all its data elements are empty.Returns the pattern of a string format.Returns the category of a string format.Returns the text align for block-level elements.Returns the value of direction property.Get the text indent.Returns one 'text-decoration' property to set line-through styles.Returns one 'text-decoration' property to set overline styles.Returns the value to transform the text.Returns one 'text-decoration' property to set underline styles.Returns the value of the vertical align property for inline elements.Returns the white space for block elements.Returns the value of widows.getWidth()Returns the value of width property.Get the spacing between two words.voidsetBackgroundAttachment(String value) Sets the background attachment.voidsetBackgroundColor(String color) Set the background color.voidsetBackgroundHeight(String value) Set the background height of the background image.voidsetBackgroundImage(String value) Sets the address of the background image.voidsetBackgroundImageType(String value) Sets the source type of the background image.voidSet the x position for the background.voidSet the y position for the background.voidsetBackgroundRepeat(String value) Sets the repeat pattern for a background image.voidsetBackgroundWidth(String value) Set the background width of the background image.voidsetBorderBottomColor(String color) Set the color of the bottom side of the border.voidsetBorderBottomStyle(String value) Sets the style of the bottom line of the border.voidsetBorderBottomWidth(String width) Set the width of the bottom side of the border.voidsetBorderLeftColor(String color) Set the color of the left side of the border.voidsetBorderLeftStyle(String value) Sets the style of the left line of the border.voidsetBorderLeftWidth(String width) Set the width of left side of the border.voidsetBorderRightColor(String color) Set the color of the right side of the border.voidsetBorderRightStyle(String value) Sets the style of the right line of the border.voidsetBorderRightWidth(String width) Set the width of the right side of the border.voidsetBorderTopColor(String color) Set the color of the top side of the border.voidsetBorderTopStyle(String value) Sets the style of the top line of the border.voidsetBorderTopWidth(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.voidSet the font color.voidsetDateTimeFormat(String pattern) Sets the pattern of a date time format for a highlight rule.voidsetDateTimeFormatCategory(String pattern) Sets the category of a number format.voidsetDisplay(String value) Sets the value that specifies if a top-level element should be a block or in-line element.voidsetFontFamily(String fontFamily) Set the font family.voidsetFontSize(String fontSize) Set the font size.voidsetFontStyle(String fontStyle) Sets the style of the font.voidsetFontVariant(String fontVariant) Sets the variant of the font.voidsetFontWeight(String fontWeight) Sets the weight of the font.voidSets the value of height property.voidsetLetterSpacing(String spacing) Set the spacing between individual letters.voidsetLineHeight(String height) Set the height of a line.voidsetMarginBottom(String margin) Set the margin of the bottom side.voidsetMarginLeft(String margin) Set the margin of the left side.voidsetMarginRight(String margin) Set the margin of the right side.voidsetMarginTop(String margin) Set the margin of the top side.voidsetMasterPage(String value) Sets the master page name on which to start this section.voidsetNumberFormat(String pattern) Sets the pattern of a number format.voidsetNumberFormatCategory(String category) Sets the category of a number format for a highlight rule.voidsetOrphans(String value) Sets the orphans property.voidsetOverflow(String value) Sets the value of overflow property.voidsetPaddingBottom(String padding) Set the padding of the bottom side.voidsetPaddingLeft(String padding) Set the padding of the left side.voidsetPaddingRight(String padding) Set the padding of the right side.voidsetPaddingTop(String padding) Set the padding of the top side.voidsetPageBreakAfter(String value) Sets the page break after property for block-level elements.voidsetPageBreakBefore(String value) Sets the page break before property for block-level elements.voidsetPageBreakInside(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(String pattern) Sets the pattern of a string format.voidsetStringFormatCategory(String pattern) Sets the category of a string format.voidsetTextAlign(String value) Sets the text align for block-level elements.voidsetTextDirection(String value) Sets the Bidi direction property.voidsetTextIndent(String indent) Set the text indent.voidsetTextLineThrough(String value) Sets one 'text-decoration' property to set line-through styles.voidsetTextOverline(String value) Sets one 'text-decoration' property to set overline styles.voidsetTextTransform(String value) Sets the value used to transform the text.voidsetTextUnderline(String value) Sets one 'text-decoration' property to set underline styles.voidsetVerticalAlign(String value) Sets the value of the vertical align property for inline elements.voidsetWhiteSpace(String value) Sets the white space property for block elements.voidSets the widows property.voidSets the value of width property.voidsetWordSpacing(String spacing) Set the spacing between two words.
-
Method Details
-
getBackgroundAttachment
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
Sets 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
String getBackgroundImage()Returns the address of the background image.- Returns:
- the address of the background image as a string
-
setBackgroundImage
Sets 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
String getBackgroundImageType()Returns the source type of the background image.- Returns:
- the source type of the background image as a string
-
setBackgroundImageType
Sets 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
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
Sets 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.
-
setBackgroundHeight
Set the background height of the background image.- Parameters:
value- the new background image height- Throws:
SemanticException
-
getBackgroundHeight
String getBackgroundHeight()Returns the height of the background image.- Returns:
- the background image height
-
setBackgroundWidth
Set the background width of the background image.- Parameters:
value- the new background image width- Throws:
SemanticException
-
getBackgroundWidth
String getBackgroundWidth()Returns the width of the background image.- Returns:
- the background image width
-
getBorderBottomStyle
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
Sets 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:
-
getStringFormat
String getStringFormat()Returns the pattern of a string format.- Returns:
- the pattern of a string format
-
setStringFormat
Sets the pattern of a string format.- Parameters:
pattern- the pattern of a string forma- Throws:
SemanticException- if the property is locked
-
getStringFormatCategory
String getStringFormatCategory()Returns the category of a string format.- Returns:
- the category of a string format
-
setStringFormatCategory
Sets 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
String getNumberFormat()Returns the pattern of a number format for a style.- Returns:
- the pattern of a number format
-
setNumberFormat
Sets the pattern of a number format.- Parameters:
pattern- the pattern of a number format- Throws:
SemanticException- if the property is locked
-
getNumberFormatCategory
String getNumberFormatCategory()Returns the category of a number format for a style.- Returns:
- the category of a number format
-
setNumberFormatCategory
Sets 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
String getDateTimeFormat()Returns the pattern of the date-time-format.- Returns:
- the pattern of the date-time-format
-
setDateTimeFormat
Sets 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
String getDateTimeFormatCategory()Returns the category of the date-time-format.- Returns:
- the category of the date-time-format
-
setDateTimeFormatCategory
Sets 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
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
Sets 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
String getMasterPage()Returns the name of the master page on which to start this section.- Returns:
- the master page name
- See Also:
-
setMasterPage
Sets 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:
-
getOrphans
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
Sets 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:
-
getPageBreakAfter
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
Sets 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
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
Sets 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
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
Sets 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
Sets 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:
-
getTextUnderline
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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:
-
getColor
String getColor()Get the font color.- Returns:
- color
-
setColor
Set the font color.- Parameters:
color-- Throws:
SemanticException
-
getBackgroundColor
String getBackgroundColor()Get the background color.- Returns:
- background color
-
setBackgroundColor
Set the background color.- Parameters:
color-- Throws:
SemanticException
-
getBorderTopColor
String getBorderTopColor()Get the color of the top side of the border.- Returns:
- color of top border
-
setBorderTopColor
Set the color of the top side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderLeftColor
String getBorderLeftColor()Get the color of the left side of the border.- Returns:
- color of left side of border
-
setBorderLeftColor
Set the color of the left side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderRightColor
String getBorderRightColor()Get the color of the right side of the border.- Returns:
- color of right side of border
-
setBorderRightColor
Set the color of the right side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBorderBottomColor
String getBorderBottomColor()Get the color of the bottom side of the border.- Returns:
- color of bottom side of border
-
setBorderBottomColor
Set the color of the bottom side of the border.- Parameters:
color-- Throws:
SemanticException
-
getBackGroundPositionX
String getBackGroundPositionX()Get the x position for the background.- Returns:
- x position
-
setBackGroundPositionX
Set the x position for the background.- Parameters:
x-- Throws:
SemanticException
-
getBackGroundPositionY
String getBackGroundPositionY()Get the y position for the background.- Returns:
- y position
-
setBackGroundPositionY
Set the y position for the background.- Parameters:
y-- Throws:
SemanticException
-
getLetterSpacing
String getLetterSpacing()Get the spacing between individual letters.- Returns:
- spacing
-
setLetterSpacing
Set the spacing between individual letters.- Parameters:
spacing-- Throws:
SemanticException
-
getLineHeight
String getLineHeight()Get the height of a line. Implies spacing between lines.- Returns:
- height of a line
-
setLineHeight
Set the height of a line. Implies spacing between lines.- Parameters:
height-- Throws:
SemanticException
-
getTextIndent
String getTextIndent()Get the text indent.- Returns:
- text indent
-
setTextIndent
Set the text indent.- Parameters:
indent-- Throws:
SemanticException
-
getWordSpacing
String getWordSpacing()Get the spacing between two words.- Returns:
- spacing
-
setWordSpacing
Set the spacing between two words.- Parameters:
spacing-- Throws:
SemanticException
-
getBorderTopWidth
String getBorderTopWidth()Get the width of the top side of the border.- Returns:
- width of top side of border
-
setBorderTopWidth
Set the width of the top side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderLeftWidth
String getBorderLeftWidth()Get the width of left side of the border.- Returns:
- width of left side of border
-
setBorderLeftWidth
Set the width of left side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderRightWidth
String getBorderRightWidth()Get the width of right side of the border.- Returns:
- width of right side of border
-
setBorderRightWidth
Set the width of the right side of the border.- Parameters:
width-- Throws:
SemanticException
-
getBorderBottomWidth
String getBorderBottomWidth()Get the width of the bottom side of the border.- Returns:
- width of bottom side of border
-
setBorderBottomWidth
Set the width of the bottom side of the border.- Parameters:
width-- Throws:
SemanticException
-
getMarginTop
String getMarginTop()Get the margin of the top side.- Returns:
- margin of top side.
-
setMarginTop
Set the margin of the top side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginRight
String getMarginRight()Get the margin of the right side.- Returns:
- margin of right side
-
setMarginRight
Set the margin of the right side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginLeft
String getMarginLeft()Get the margin of the left side.- Returns:
- margin of left side
-
setMarginLeft
Set the margin of the left side.- Parameters:
margin-- Throws:
SemanticException
-
getMarginBottom
String getMarginBottom()Get the margin of the bottom side.- Returns:
- margin of bottom side
-
setMarginBottom
Set the margin of the bottom side.- Parameters:
margin-- Throws:
SemanticException
-
getPaddingTop
String getPaddingTop()Get the padding of the top side.- Returns:
- padding of top side
-
setPaddingTop
Set the padding of the top side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingRight
String getPaddingRight()Get the padding of the right side.- Returns:
- padding of right side
-
setPaddingRight
Set the padding of the right side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingLeft
String getPaddingLeft()Get the padding of the left side.- Returns:
- padding of left side
-
setPaddingLeft
Set the padding of the left side.- Parameters:
padding-- Throws:
SemanticException
-
getPaddingBottom
String getPaddingBottom()Get the padding of the bottom side.- Returns:
- padding of bottom side
-
setPaddingBottom
Set the padding of the bottom side.- Parameters:
padding-- Throws:
SemanticException
-
getFontSize
String getFontSize()Get the font size.- Returns:
- font size
-
setFontSize
Set the font size.- Parameters:
fontSize-- Throws:
SemanticException
-
getFontFamily
String getFontFamily()Get the font family.- Returns:
- font family
-
setFontFamily
Set the font family.- Parameters:
fontFamily-- Throws:
SemanticException
-
getFontWeight
String getFontWeight()Get the weight of the font.- Returns:
- weight of font
-
setFontWeight
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
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
Sets 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
String getHeight()Returns the value of height property.- Returns:
- the value of height property.
-
setHeight
Sets the value of height property.- Parameters:
height- the new height value- Throws:
SemanticException
-
getWidth
String getWidth()Returns the value of width property.- Returns:
- the value of width property.
-
setWidth
Sets the value of width property.- Parameters:
width- the new width value- Throws:
SemanticException
-