Class TOCStyle
java.lang.Object
org.eclipse.birt.report.engine.api.TOCStyle
- All Implemented Interfaces:
Serializable
,org.eclipse.birt.report.engine.api.script.instance.IScriptStyle
public class TOCStyle
extends Object
implements org.eclipse.birt.report.engine.api.script.instance.IScriptStyle, Serializable
Definition of the TOC styles
- Since:
- 3.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Style property: background-attachmentstatic final String
Style property: background-colorstatic final String
Style property: background-imagestatic final String
Style property: background-image-typestatic final String
Style property: background-position-xstatic final String
Style property: background-position-ystatic final String
Style property: background-repeatstatic final String
Style property: background image heightstatic final String
Style property: background image widthstatic final String
Style property: border-antidiagonal-colorstatic final String
Style property: border-antidiagonal-numberstatic final String
Style property: border-antidiagonal-stylestatic final String
Style property: border-antidiagonal-widthstatic final String
Style property: border-bottom-colorstatic final String
Style property: border-bottom-stylestatic final String
Style property: border-bottom-widthstatic final String
Style property: border-diagonal-colorstatic final String
Style property: border-diagonal-numberstatic final String
Style property: border-diagonal-stylestatic final String
Style property: border-diagonal-widthstatic final String
Style property: border-left-colorstatic final String
Style property: border-left-stylestatic final String
Style property: border-left-widthstatic final String
Style property: border-right-colorstatic final String
Style property: border-right-stylestatic final String
Style property: border-right-widthstatic final String
Style property: border-top-colorstatic final String
Style property: border-top-stylestatic final String
Style property: border-top-widthstatic final String
Style property: can-shrinkstatic final String
Style property: colorstatic final String
Style property: date-formatstatic final String
Style property: date-localstatic final String
Style property: directionstatic final String
Style property: displaystatic final String
Style property: font-familystatic final String
Style property: font-sizestatic final String
Style property: font-stylestatic final String
Style property: font-variantstatic final String
Style property: font-weightstatic final String
Style property: letter-spacingstatic final String
Style property: line-heightstatic final String
Style property: margin-bottomstatic final String
Style property: margin-leftstatic final String
Style property: margin-rightstatic final String
Style property: margin-topstatic final String
Style property: margin-pagestatic final String
Style property: number-formatstatic final String
Style property: number-localstatic final String
Style property: padding-bottomstatic final String
Style property: padding-leftstatic final String
Style property: padding-rightstatic final String
Style property: padding-topstatic final String
Style property: page-break-afterstatic final String
Style property: page-break-beforestatic final String
Style property: page-break-insidestatic final String
Style property: show-if-blankstatic final String
Style property: string-formatstatic final String
Style property: string-localstatic final String
Style property: text-alignstatic final String
Style property: text-indentstatic final String
Style property: text-line-throughstatic final String
Style property: text-overlinestatic final String
Style property: text-transformstatic final String
Style property: text-underlinestatic final String
Style property: vertical-alignstatic final String
Style property: visible-formatstatic final String
Style property: white-spacestatic final String
Style property: word-spacing -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
Get the attachment type (either SCROLL or FIXED)Get the background colorGet the background image heightGet the background image URIGet the background image source typeGet the X (horizontal) position of the background imageGet the Y (vertical) position of the background imageGet the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)Get the background image heightGet the bottom border colorGet the bottom border style.Get the bottom border width.Get the left border colorGet the left border style.Get the left border width.Get the right border colorGet the right border style.Get the right border width.Get the top border colorGet the top border style.Get the top border width.Can this element shrink?getColor()
Get the font colorGet the date formatint
Get the directionGet the display type (valid types are BLOCK, INLINE and NONE)Get the font familyGet the font sizeGet the font styleGet the font variantGet the font weightGet the letter spacingGet the line heightGet the bottom marginGet the left marginGet the right marginGet the top marginGet the master pageGet number formatGet the bottom padding.Get the left padding.Get the right padding.Get the top padding.Get the page break after.Get the page break before.Get the page break inside.Get properties.Show if blank?Get the string formatGet the text alignment.Get the text indentGet the text line throughGet the text overlineGet the text transform.Get the text underlineGet the vertical alignment.Get format to hide in.Get the whitespace.Get the word spacingvoid
setAntidiagonalColor
(String color) void
setAntidiagonalNumber
(int number) void
setAntidiagonalStyle
(String style) void
setAntidiagonalWidth
(String width) void
setBackgroundAttachement
(String attachement) void
setBackgroundAttachment
(String attachment) Set the attachment type (either SCROLL or FIXED)void
setBackgroundColor
(String color) Set the background colorvoid
setBackgroundHeight
(String height) Set the background image heightvoid
setBackgroundImage
(String imageURI) Set the background image URIvoid
setBackgroundImageType
(String imageSourceType) Set the background image source typevoid
Set the X (horizontal) position of the background imagevoid
Set the Y (vertical) position of the background imagevoid
setBackgroundRepeat
(String repeat) Set the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)void
setBackgroundWidth
(String width) Set the background image heightvoid
setBorderBottomColor
(String color) Set the bottom border colorvoid
setBorderBottomStyle
(String borderstyle) Set the bottom border style.void
setBorderBottomWidth
(String width) Set the bottom border width.void
setBorderLeftColor
(String color) Set the left border colorvoid
setBorderLeftStyle
(String borderstyle) Set the left border style.void
setBorderLeftWidth
(String width) Set the left border width.void
setBorderRightColor
(String color) Set the right border colorvoid
setBorderRightStyle
(String borderstyle) Get the right border style.void
setBorderRightWidth
(String width) Set the right border width.void
setBorderTopColor
(String color) Set the top border colorvoid
setBorderTopStyle
(String borderstyle) Get the top border style.void
setBorderTopWidth
(String width) Set the top border width.void
setCanShrink
(String canShrink) Can this element shrink?void
Set the font colorvoid
setDateFormat
(String dateTimeFormat) Set the date formatvoid
setDateLocale
(String locale) void
setDiagonalColor
(String color) void
setDiagonalNumber
(int number) void
setDiagonalStyle
(String style) void
setDiagonalWidth
(String width) void
setDirection
(String direction) Set directionvoid
setDisplay
(String display) Set the display type (valid types are BLOCK, INLINE and NONE)void
setFontFamily
(String fontFamily) Set the font familyvoid
setFontSize
(String fontSize) Set the font sizevoid
setFontStyle
(String fontStyle) Set the font stylevoid
setFontVariant
(String fontVariant) Set the font variantvoid
setFontWeight
(String fontWeight) Set the font weightvoid
setLetterSpacing
(String spacing) Set the letter spacingvoid
setLineHeight
(String lineHeight) Set the line heightvoid
setMarginBottom
(String margin) Set the bottom marginvoid
setMarginLeft
(String margin) Set the left marginvoid
setMarginRight
(String margin) Set the right marginvoid
setMarginTop
(String margin) Set the top marginvoid
setMasterPage
(String masterPage) Set the master pagevoid
setNumberFormat
(String numberFormat) Set the number formatvoid
setNumberLocale
(String locale) void
setPaddingBottom
(String padding) Set the bottom padding.void
setPaddingLeft
(String padding) Set the left padding.void
setPaddingRight
(String padding) Set the right padding.void
setPaddingTop
(String padding) Set the top padding.void
setPageBreakAfter
(String pageBreak) Set the page break aftervoid
setPageBreakBefore
(String pageBreak) Set the page break beforevoid
setPageBreakInside
(String pageBreak) Set the page break insidevoid
setProperty
(String name, String value) Set property.void
setShowIfBlank
(String showIfBlank) Set show if blankvoid
setStringFormat
(String stringFormat) Set the string formatvoid
setStringLocale
(String locale) void
setTextAlign
(String align) Set the text alignment.void
setTextIndent
(String indent) Set the text indentvoid
setTextLineThrough
(String through) Set the text line throughvoid
setTextOverline
(String overline) Set the text overlinevoid
setTextTransform
(String transform) Set the text transform.void
setTextUnderline
(String underline) Set the text underlinevoid
setVerticalAlign
(String valign) Set the vertical alignment.void
setVisibleFormat
(String format) Set format to hide in.void
setWhiteSpace
(String whitespace) Set the whitespace.void
setWordSpacing
(String wordspacing) Set the word spacingtoString()
-
Field Details
-
BACKGROUND_ATTACHMENT
Style property: background-attachment- See Also:
-
BACKGROUND_COLOR
Style property: background-color- See Also:
-
BACKGROUND_IMAGE
Style property: background-image- See Also:
-
BACKGROUND_IMAGE_TYPE
Style property: background-image-type- See Also:
-
BACKGROUND_SIZE_HEIGHT
Style property: background image height- See Also:
-
BACKGROUND_SIZE_WIDTH
Style property: background image width- See Also:
-
BACKGROUND_POSITION_X
Style property: background-position-x- See Also:
-
BACKGROUND_POSITION_Y
Style property: background-position-y- See Also:
-
BACKGROUND_REPEAT
Style property: background-repeat- See Also:
-
BORDER_BOTTOM_COLOR
Style property: border-bottom-color- See Also:
-
BORDER_TOP_COLOR
Style property: border-top-color- See Also:
-
BORDER_LEFT_COLOR
Style property: border-left-color- See Also:
-
BORDER_RIGHT_COLOR
Style property: border-right-color- See Also:
-
BORDER_BOTTOM_WIDTH
Style property: border-bottom-width- See Also:
-
BORDER_TOP_WIDTH
Style property: border-top-width- See Also:
-
BORDER_LEFT_WIDTH
Style property: border-left-width- See Also:
-
BORDER_RIGHT_WIDTH
Style property: border-right-width- See Also:
-
BORDER_BOTTOM_STYLE
Style property: border-bottom-style- See Also:
-
BORDER_TOP_STYLE
Style property: border-top-style- See Also:
-
BORDER_LEFT_STYLE
Style property: border-left-style- See Also:
-
BORDER_RIGHT_STYLE
Style property: border-right-style- See Also:
-
BORDER_DIAGONAL_NUMBER
Style property: border-diagonal-number- See Also:
-
BORDER_DIAGONAL_STYLE
Style property: border-diagonal-style- See Also:
-
BORDER_DIAGONAL_WIDTH
Style property: border-diagonal-width- See Also:
-
BORDER_DIAGONAL_COLOR
Style property: border-diagonal-color- See Also:
-
BORDER_ANTIDIAGONAL_NUMBER
Style property: border-antidiagonal-number- See Also:
-
BORDER_ANTIDIAGONAL_STYLE
Style property: border-antidiagonal-style- See Also:
-
BORDER_ANTIDIAGONAL_WIDTH
Style property: border-antidiagonal-width- See Also:
-
BORDER_ANTIDIAGONAL_COLOR
Style property: border-antidiagonal-color- See Also:
-
CAN_SHRINK
Style property: can-shrink- See Also:
-
COLOR
Style property: color- See Also:
-
DATE_FORMAT
Style property: date-format- See Also:
-
DIRECTION
Style property: direction- See Also:
-
DISPLAY
Style property: display- See Also:
-
FONT_FAMILY
Style property: font-family- See Also:
-
FONT_SIZE
Style property: font-size- See Also:
-
FONT_STYLE
Style property: font-style- See Also:
-
FONT_VARIANT
Style property: font-variant- See Also:
-
FONT_WEIGHT
Style property: font-weight- See Also:
-
LETTER_SPACING
Style property: letter-spacing- See Also:
-
LINE_HEIGHT
Style property: line-height- See Also:
-
MARGIN_BOTTOM
Style property: margin-bottom- See Also:
-
MARGIN_LEFT
Style property: margin-left- See Also:
-
MARGIN_RIGHT
Style property: margin-right- See Also:
-
MARGIN_TOP
Style property: margin-top- See Also:
-
MASTER_PAGE
Style property: margin-page- See Also:
-
NUMBER_FORMAT
Style property: number-format- See Also:
-
PADDING_BOTTOM
Style property: padding-bottom- See Also:
-
PADDING_LEFT
Style property: padding-left- See Also:
-
PADDING_RIGHT
Style property: padding-right- See Also:
-
PADDING_TOP
Style property: padding-top- See Also:
-
PAGE_BREAK_AFTER
Style property: page-break-after- See Also:
-
PAGE_BREAK_BEFORE
Style property: page-break-before- See Also:
-
PAGE_BREAK_INSIDE
Style property: page-break-inside- See Also:
-
SHOW_IF_BLANK
Style property: show-if-blank- See Also:
-
STRING_FORMAT
Style property: string-format- See Also:
-
TEXT_ALIGN
Style property: text-align- See Also:
-
TEXT_INDENT
Style property: text-indent- See Also:
-
TEXT_LINE_THROUGH
Style property: text-line-through- See Also:
-
TEXT_OVERLINE
Style property: text-overline- See Also:
-
TEXT_TRANSFORM
Style property: text-transform- See Also:
-
TEXT_UNDERLINE
Style property: text-underline- See Also:
-
VERTICAL_ALIGN
Style property: vertical-align- See Also:
-
VISIBLE_FORMAT
Style property: visible-format- See Also:
-
WHITE_SPACE
Style property: white-space- See Also:
-
WORD_SPACING
Style property: word-spacing- See Also:
-
DATE_LOCALE
Style property: date-local- See Also:
-
NUMBER_LOCALE
Style property: number-local- See Also:
-
STRING_LOCALE
Style property: string-local- See Also:
-
-
Constructor Details
-
TOCStyle
public TOCStyle()
-
-
Method Details
-
getBackgroundAttachement
- Specified by:
getBackgroundAttachement
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundAttachment
Get the attachment type (either SCROLL or FIXED)- Specified by:
getBackgroundAttachment
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundColor
Get the background color- Specified by:
getBackgroundColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundImage
Get the background image URI- Specified by:
getBackgroundImage
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundImageType
Get the background image source type- Specified by:
getBackgroundImageType
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundPositionX
Get the X (horizontal) position of the background image- Specified by:
getBackgroundPositionX
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundPositionY
Get the Y (vertical) position of the background image- Specified by:
getBackgroundPositionY
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundRepeat
Get the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)- Specified by:
getBackgroundRepeat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundHeight
Get the background image height- Specified by:
getBackgroundHeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBackgroundWidth
Get the background image height- Specified by:
getBackgroundWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderBottomColor
Get the bottom border color- Specified by:
getBorderBottomColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderBottomStyle
Get the bottom border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
getBorderBottomStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderBottomWidth
Get the bottom border width.- Specified by:
getBorderBottomWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderLeftColor
Get the left border color- Specified by:
getBorderLeftColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderLeftStyle
Get the left border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
getBorderLeftStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderLeftWidth
Get the left border width.- Specified by:
getBorderLeftWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderRightColor
Get the right border color- Specified by:
getBorderRightColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderRightStyle
Get the right border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
getBorderRightStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderRightWidth
Get the right border width.- Specified by:
getBorderRightWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderTopColor
Get the top border color- Specified by:
getBorderTopColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderTopStyle
Get the top border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
getBorderTopStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getBorderTopWidth
Get the top border width.- Specified by:
getBorderTopWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getCanShrink
Can this element shrink?- Specified by:
getCanShrink
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getColor
Get the font color- Specified by:
getColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getDateFormat
Get the date format- Specified by:
getDateFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Returns:
- date format
-
getDirection
Get the direction- Returns:
- Return the direction
-
getDisplay
Get the display type (valid types are BLOCK, INLINE and NONE)- Specified by:
getDisplay
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getFontFamily
Get the font family- Specified by:
getFontFamily
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getFontSize
Get the font size- Specified by:
getFontSize
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getFontStyle
Get the font style- Specified by:
getFontStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getFontVariant
Get the font variant- Specified by:
getFontVariant
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getFontWeight
Get the font weight- Specified by:
getFontWeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getLetterSpacing
Get the letter spacing- Specified by:
getLetterSpacing
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getLineHeight
Get the line height- Specified by:
getLineHeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getMarginBottom
Get the bottom margin- Specified by:
getMarginBottom
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getMarginLeft
Get the left margin- Specified by:
getMarginLeft
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getMarginRight
Get the right margin- Specified by:
getMarginRight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getMarginTop
Get the top margin- Specified by:
getMarginTop
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getMasterPage
Get the master page- Specified by:
getMasterPage
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getNumberFormat
Get number format- Specified by:
getNumberFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Returns:
- the number format
-
getPaddingBottom
Get the bottom padding.- Specified by:
getPaddingBottom
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPaddingLeft
Get the left padding.- Specified by:
getPaddingLeft
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPaddingRight
Get the right padding.- Specified by:
getPaddingRight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPaddingTop
Get the top padding.- Specified by:
getPaddingTop
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPageBreakAfter
Get the page break after.- Specified by:
getPageBreakAfter
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPageBreakBefore
Get the page break before.- Specified by:
getPageBreakBefore
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getPageBreakInside
Get the page break inside.- Specified by:
getPageBreakInside
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getShowIfBlank
Show if blank?- Specified by:
getShowIfBlank
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getStringFormat
Get the string format- Specified by:
getStringFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Returns:
- the string format
-
getTextAlign
Get the text alignment. Valid return types are LEFT, RIGHT, CENTER and JUSTIFY.- Specified by:
getTextAlign
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getTextIndent
Get the text indent- Specified by:
getTextIndent
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getTextLineThrough
Get the text line through- Specified by:
getTextLineThrough
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getTextOverline
Get the text overline- Specified by:
getTextOverline
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getTextTransform
Get the text transform. Valid return values are NONE, CAPITALIZE, UPPERCASE and LOWERCASE.- Specified by:
getTextTransform
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getTextUnderline
Get the text underline- Specified by:
getTextUnderline
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getVerticalAlign
Get the vertical alignment. Valid return values are BASELINE, SUB, SUPER, TOP, TEXT_TOP, MIDDLE, BOTTOM and TEXT_BOTTOM- Specified by:
getVerticalAlign
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getVisibleFormat
Get format to hide in. Should be one of org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_ALL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_VIEWER org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EMAIL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PRINT org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PDF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_RTF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_REPORTLET org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EXCEL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_WORD org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_POWERPOINT- Specified by:
getVisibleFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getWhiteSpace
Get the whitespace. Valid return values are NORMAL, PRE and NOWRAP- Specified by:
getWhiteSpace
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getWordSpacing
Get the word spacing- Specified by:
getWordSpacing
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundAttachement
- Specified by:
setBackgroundAttachement
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundAttachment
Set the attachment type (either SCROLL or FIXED)- Specified by:
setBackgroundAttachment
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundColor
Set the background color- Specified by:
setBackgroundColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundImage
Set the background image URI- Specified by:
setBackgroundImage
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundImageType
Set the background image source type- Specified by:
setBackgroundImageType
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundPositionX
Set the X (horizontal) position of the background image- Specified by:
setBackgroundPositionX
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundPositionY
Set the Y (vertical) position of the background image- Specified by:
setBackgroundPositionY
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundRepeat
Set the background repeat type (valid types are REPEAT, REPEAT_X, REPEAT_Y and NO_REPEAT)- Specified by:
setBackgroundRepeat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundHeight
Set the background image height- Specified by:
setBackgroundHeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBackgroundWidth
Set the background image height- Specified by:
setBackgroundWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderBottomColor
Set the bottom border color- Specified by:
setBorderBottomColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderBottomStyle
Set the bottom border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
setBorderBottomStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderBottomWidth
Set the bottom border width.- Specified by:
setBorderBottomWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderLeftColor
Set the left border color- Specified by:
setBorderLeftColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderLeftStyle
Set the left border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
setBorderLeftStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderLeftWidth
Set the left border width.- Specified by:
setBorderLeftWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderRightColor
Set the right border color- Specified by:
setBorderRightColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderRightStyle
Get the right border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
setBorderRightStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderRightWidth
Set the right border width.- Specified by:
setBorderRightWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderTopColor
Set the top border color- Specified by:
setBorderTopColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderTopStyle
Get the top border style. Valid styles are NONE, SOLID, DOTTED, DASHED, DOUBLE, GROVE, RIDGE, INSET and OUTSET.- Specified by:
setBorderTopStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setBorderTopWidth
Set the top border width.- Specified by:
setBorderTopWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setCanShrink
Can this element shrink?- Specified by:
setCanShrink
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setColor
Set the font color- Specified by:
setColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDateFormat
Set the date format- Specified by:
setDateFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Parameters:
dateTimeFormat
-
-
setDirection
Set direction- Parameters:
direction
-
-
setDisplay
Set the display type (valid types are BLOCK, INLINE and NONE)- Specified by:
setDisplay
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setFontFamily
Set the font family- Specified by:
setFontFamily
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setFontSize
Set the font size- Specified by:
setFontSize
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setFontStyle
Set the font style- Specified by:
setFontStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setFontVariant
Set the font variant- Specified by:
setFontVariant
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setFontWeight
Set the font weight- Specified by:
setFontWeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setLetterSpacing
Set the letter spacing- Specified by:
setLetterSpacing
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setLineHeight
Set the line height- Specified by:
setLineHeight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setMarginBottom
Set the bottom margin- Specified by:
setMarginBottom
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setMarginLeft
Set the left margin- Specified by:
setMarginLeft
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setMarginRight
Set the right margin- Specified by:
setMarginRight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setMarginTop
Set the top margin- Specified by:
setMarginTop
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setMasterPage
Set the master page- Specified by:
setMasterPage
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setNumberFormat
Set the number format- Specified by:
setNumberFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Parameters:
numberFormat
-
-
setPaddingBottom
Set the bottom padding.- Specified by:
setPaddingBottom
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPaddingLeft
Set the left padding.- Specified by:
setPaddingLeft
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPaddingRight
Set the right padding.- Specified by:
setPaddingRight
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPaddingTop
Set the top padding.- Specified by:
setPaddingTop
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPageBreakAfter
Set the page break after- Specified by:
setPageBreakAfter
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPageBreakBefore
Set the page break before- Specified by:
setPageBreakBefore
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setPageBreakInside
Set the page break inside- Specified by:
setPageBreakInside
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setShowIfBlank
Set show if blank- Specified by:
setShowIfBlank
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setStringFormat
Set the string format- Specified by:
setStringFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Parameters:
stringFormat
-
-
setTextAlign
Set the text alignment. Valid return types are LEFT, RIGHT, CENTER and JUSTIFY.- Specified by:
setTextAlign
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setTextIndent
Set the text indent- Specified by:
setTextIndent
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setTextLineThrough
Set the text line through- Specified by:
setTextLineThrough
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setTextOverline
Set the text overline- Specified by:
setTextOverline
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setTextTransform
Set the text transform. Valid transform values are NONE, CAPITALIZE, UPPERCASE and LOWERCASE.- Specified by:
setTextTransform
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setTextUnderline
Set the text underline- Specified by:
setTextUnderline
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setVerticalAlign
Set the vertical alignment. Valid values are BASELINE, SUB, SUPER, TOP, TEXT_TOP, MIDDLE, BOTTOM and TEXT_BOTTOM- Specified by:
setVerticalAlign
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setVisibleFormat
Set format to hide in. Should be one of org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_ALL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_VIEWER org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EMAIL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PRINT org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_PDF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_RTF org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_REPORTLET org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_EXCEL org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_WORD org.eclipse.birt.report.model.api.elements.DesignChoiceConstants.FORMAT_TYPE_POWERPOINT- Specified by:
setVisibleFormat
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
- Parameters:
format
-
-
setWhiteSpace
Set the whitespace. Valid return values are NORMAL, PRE and NOWRAP- Specified by:
setWhiteSpace
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setWordSpacing
Set the word spacing- Specified by:
setWordSpacing
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getDateLocale
- Specified by:
getDateLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDateLocale
- Specified by:
setDateLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getNumberLocale
- Specified by:
getNumberLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setNumberLocale
- Specified by:
setNumberLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getStringLocale
- Specified by:
getStringLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setStringLocale
- Specified by:
setStringLocale
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setProperty
Set property.- Parameters:
name
-value
-
-
getProperties
Get properties.- Returns:
- Return properties
-
toString
-
getDiagonalNumber
public int getDiagonalNumber()- Specified by:
getDiagonalNumber
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDiagonalNumber
public void setDiagonalNumber(int number) - Specified by:
setDiagonalNumber
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getDiagonalStyle
- Specified by:
getDiagonalStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDiagonalStyle
- Specified by:
setDiagonalStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getDiagonalWidth
- Specified by:
getDiagonalWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDiagonalWidth
- Specified by:
setDiagonalWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getDiagonalColor
- Specified by:
getDiagonalColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setDiagonalColor
- Specified by:
setDiagonalColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getAntidiagonalNumber
public int getAntidiagonalNumber()- Specified by:
getAntidiagonalNumber
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setAntidiagonalNumber
public void setAntidiagonalNumber(int number) - Specified by:
setAntidiagonalNumber
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getAntidiagonalStyle
- Specified by:
getAntidiagonalStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setAntidiagonalStyle
- Specified by:
setAntidiagonalStyle
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getAntidiagonalWidth
- Specified by:
getAntidiagonalWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setAntidiagonalWidth
- Specified by:
setAntidiagonalWidth
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
getAntidiagonalColor
- Specified by:
getAntidiagonalColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-
setAntidiagonalColor
- Specified by:
setAntidiagonalColor
in interfaceorg.eclipse.birt.report.engine.api.script.instance.IScriptStyle
-