|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.StyleHandle
Represents the style properties for either a shared style or an element with a style. A style is defined by a name and a set of style property values. Most styles define values for a small subset of possible values.
A style includes a collection of properties such as font face name, font color, fill color and so on. A property is simply a (name, value) pair. The name identifies the property, and the value is what has been set for the property: ¡°red¡± or ¡°Arial¡± or ¡°10 pt.¡± A property value can be blank, meaning that the user has not specified anything for that property.
Each style has a highlight. Each highlight rule has a condition and a set of formatting options to apply if the rule is true. BIRT evaluates each rule in term, and applies the first one that evaluates to true. As a result, the rules need not be mutually exclusive, and the order of the rules matters.
Each style has a map. The map has a condition and a set of rules. A map rule transforms a value in the input into a different value for display. It works best for fields with a limited set of values, such as converting ¡°Y¡± to ¡°Yes¡± and ¡°N¡± to ¡°No¡±. Mappings with many rules are better handled in the data access layer. Another common use of mapping is to convert a null value into a display value, such as ¡°No Data.¡±
DesignChoiceConstants
Field Summary |
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IStyleModel |
BACKGROUND_ATTACHMENT_PROP, BACKGROUND_COLOR_PROP, BACKGROUND_IMAGE_PROP, BACKGROUND_POSITION_X_PROP, BACKGROUND_POSITION_Y_PROP, BACKGROUND_REPEAT_PROP, BORDER_BOTTOM_COLOR_PROP, BORDER_BOTTOM_STYLE_PROP, BORDER_BOTTOM_WIDTH_PROP, BORDER_LEFT_COLOR_PROP, BORDER_LEFT_STYLE_PROP, BORDER_LEFT_WIDTH_PROP, BORDER_RIGHT_COLOR_PROP, BORDER_RIGHT_STYLE_PROP, BORDER_RIGHT_WIDTH_PROP, BORDER_TOP_COLOR_PROP, BORDER_TOP_STYLE_PROP, BORDER_TOP_WIDTH_PROP, CAN_SHRINK_PROP, COLOR_PROP, DATE_TIME_FORMAT_PROP, DISPLAY_PROP, FONT_FAMILY_PROP, FONT_SIZE_PROP, FONT_STYLE_PROP, FONT_VARIANT_PROP, FONT_WEIGHT_PROP, HIGHLIGHT_RULES_PROP, LETTER_SPACING_PROP, LINE_HEIGHT_PROP, MAP_RULES_PROP, MARGIN_BOTTOM_PROP, MARGIN_LEFT_PROP, MARGIN_RIGHT_PROP, MARGIN_TOP_PROP, MASTER_PAGE_PROP, NUMBER_ALIGN_PROP, NUMBER_FORMAT_PROP, ORPHANS_PROP, PADDING_BOTTOM_PROP, PADDING_LEFT_PROP, PADDING_RIGHT_PROP, PADDING_TOP_PROP, PAGE_BREAK_AFTER_PROP, PAGE_BREAK_BEFORE_PROP, PAGE_BREAK_INSIDE_PROP, SHOW_IF_BLANK_PROP, STRING_FORMAT_PROP, TEXT_ALIGN_PROP, TEXT_INDENT_PROP, TEXT_LINE_THROUGH_PROP, TEXT_OVERLINE_PROP, TEXT_TRANSFORM_PROP, TEXT_UNDERLINE_PROP, VERTICAL_ALIGN_PROP, WHITE_SPACE_PROP, WIDOWS_PROP, WORD_SPACING_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
StyleHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a style handle with the given design and the element.. |
Method Summary | |
boolean |
canShrink()
Tests whether the section can shrink if the actual content is smaller than the design size. |
java.lang.String |
getBackgroundAttachment()
Returns a background attachment as a string. |
ColorHandle |
getBackgroundColor()
Gets a color handle to deal with the background color. |
java.lang.String |
getBackgroundImage()
Returns the address of the background image. |
DimensionHandle |
getBackGroundPositionX()
Gets a dimension handle to deal with the x position for the background. |
DimensionHandle |
getBackGroundPositionY()
Gets a dimension handle to deal with the y position for the background. |
java.lang.String |
getBackgroundRepeat()
Returns the pattern of the repeat for a background image. |
ColorHandle |
getBorderBottomColor()
Gets a color handle to deal with the color of the bottom side of the border. |
java.lang.String |
getBorderBottomStyle()
Returns the style of the bottom line of the border. |
DimensionHandle |
getBorderBottomWidth()
Gets a dimension handle to deal with the width of the bottom side of the border. |
ColorHandle |
getBorderLeftColor()
Gets a color handle to deal with the color of the left side of the border. |
java.lang.String |
getBorderLeftStyle()
Returns the style of the left line of the border. |
DimensionHandle |
getBorderLeftWidth()
Gets a dimension handle to deal with the width of the left side of the border. |
ColorHandle |
getBorderRightColor()
Gets a color handle to deal with the color of the right side of the border. |
java.lang.String |
getBorderRightStyle()
Returns the style of the right line of the border. |
DimensionHandle |
getBorderRightWidth()
Gets a dimension handle to deal with the width of the right side of the border. |
ColorHandle |
getBorderTopColor()
Gets a color handle to deal with the color of the top side of the border. |
java.lang.String |
getBorderTopStyle()
Returns the style of the top line of the border. |
DimensionHandle |
getBorderTopWidth()
Gets a dimension handle to deal with the width of the top side of the border. |
ColorHandle |
getColor()
Gets a color handle to deal with the font color. |
java.lang.String |
getDateTimeFormat()
Returns the pattern of the date-time-format. |
java.lang.String |
getDateTimeFormatCategory()
Returns the category of the date-time-format. |
java.lang.String |
getDisplay()
Returns the value that specifies if a top-level element should be a block or in-line element. |
FontHandle |
getFontFamilyHandle()
Returns the font handle to deal with the font family. |
DimensionHandle |
getFontSize()
Gets a dimension handle to deal with the font size. |
java.lang.String |
getFontStyle()
Returns the style of the font. |
java.lang.String |
getFontVariant()
Returns the variant of the font. |
java.lang.String |
getFontWeight()
Returns the weight of the font. |
java.lang.String |
getHighlightTestExpr()
Deprecated. |
DimensionHandle |
getLetterSpacing()
Gets a dimension handle to deal with the spacing between individual letters. |
DimensionHandle |
getLineHeight()
Gets a dimension handle to deal with the height of a line. |
java.lang.String |
getMapTestExpr()
Deprecated. |
DimensionHandle |
getMarginBottom()
Gets a handle to deal with the margin of the bottom side. |
DimensionHandle |
getMarginLeft()
Gets a handle to deal with the margin of the left side. |
DimensionHandle |
getMarginRight()
Gets a handle to deal with the margin of the right side. |
DimensionHandle |
getMarginTop()
Gets a handle to deal with the margin of the top side. |
java.lang.String |
getMasterPage()
Returns the name of the master page on which to start this section. |
java.lang.String |
getNumberFormat()
Returns the pattern of a number format for a style. |
java.lang.String |
getNumberFormatCategory()
Returns the category of a number format for a style. |
java.lang.String |
getOrphans()
Returns the value of orphans. |
DimensionHandle |
getPaddingBottom()
Gets a dimension handle to deal with the padding of the bottom side. |
DimensionHandle |
getPaddingLeft()
Gets a dimension handle to deal with the padding of the left side. |
DimensionHandle |
getPaddingRight()
Gets a dimension handle to deal with the padding of the right side. |
DimensionHandle |
getPaddingTop()
Gets a dimension handle to deal with the padding of the top side. |
java.lang.String |
getPageBreakAfter()
Returns the page break after property for block-level elements. |
java.lang.String |
getPageBreakBefore()
Returns the page break before property for block-level elements. |
java.lang.String |
getPageBreakInside()
Deprecated. |
java.lang.String |
getStringFormat()
Returns the pattern of a string format. |
java.lang.String |
getStringFormatCategory()
Returns the category of a string format. |
java.lang.String |
getTextAlign()
Returns the text align for block-level elements. |
DimensionHandle |
getTextIndent()
Gets a dimension handle to deal with the text indent. |
java.lang.String |
getTextLineThrough()
Returns one 'text-decoration' property to set line-through styles. |
java.lang.String |
getTextOverline()
Returns one 'text-decoration' property to set overline styles. |
java.lang.String |
getTextTransform()
Returns the value to transform the text. |
java.lang.String |
getTextUnderline()
Returns one 'text-decoration' property to set underline styles. |
java.lang.String |
getVerticalAlign()
Returns the value of the vertical align property for inline elements. |
java.lang.String |
getWhiteSpace()
Returns the white space for block elements. |
java.lang.String |
getWidows()
Returns the value of widows. |
DimensionHandle |
getWordSpacing()
Gets a dimension handle to deal with the spacing between two words. |
java.util.Iterator |
highlightRulesIterator()
Returns the iterator of highlight rules. |
boolean |
isPredefined()
checks whether this style is created by user or predefined by BIRT. |
java.util.Iterator |
mapRulesIterator()
Returns the iterator for map rules. |
void |
setBackgroundAttachment(java.lang.String value)
Sets the background attachment. |
void |
setBackgroundImage(java.lang.String value)
Sets the address of the background image. |
void |
setBackgroundRepeat(java.lang.String value)
Sets the repeat pattern for a background image. |
void |
setBorderBottomStyle(java.lang.String value)
Sets the style of the bottom line of the border. |
void |
setBorderLeftStyle(java.lang.String value)
Sets the style of the left line of the border. |
void |
setBorderRightStyle(java.lang.String value)
Sets the style of the right line of the border. |
void |
setBorderTopStyle(java.lang.String value)
Sets the style of the top line of the border. |
void |
setCanShrink(boolean value)
Sets whether the section can shrink if the actual content is smaller than the design size. |
void |
setDateTimeFormat(java.lang.String pattern)
Sets the pattern of a date time format for a highlight rule. |
void |
setDateTimeFormatCategory(java.lang.String pattern)
Sets the category of a number format. |
void |
setDisplay(java.lang.String value)
Sets the value that specifies if a top-level element should be a block or in-line element. |
void |
setFontStyle(java.lang.String fontStyle)
Sets the style of the font. |
void |
setFontVariant(java.lang.String fontVariant)
Sets the variant of the font. |
void |
setFontWeight(java.lang.String fontWeight)
Sets the weight of the font. |
void |
setHighlightTestExpr(java.lang.String value)
Deprecated. |
void |
setMapTestExpr(java.lang.String value)
Deprecated. |
void |
setMasterPage(java.lang.String value)
Sets the master page name on which to start this section. |
void |
setNumberFormat(java.lang.String pattern)
Sets the pattern of a number format. |
void |
setNumberFormatCategory(java.lang.String category)
Sets the category of a number format for a highlight rule. |
void |
setOrphans(java.lang.String value)
Sets the orphans property. |
void |
setPageBreakAfter(java.lang.String value)
Sets the page break after property for block-level elements. |
void |
setPageBreakBefore(java.lang.String value)
Sets the page break before property for block-level elements. |
void |
setPageBreakInside(java.lang.String value)
Deprecated. |
void |
setShowIfBlank(boolean value)
Sets whether to show this frame even if it is empty, or all its data elements are empty. |
void |
setStringFormat(java.lang.String pattern)
Sets the pattern of a string format. |
void |
setStringFormatCategory(java.lang.String pattern)
Sets the category of a string format. |
void |
setTextAlign(java.lang.String value)
Sets the text align for block-level elements. |
void |
setTextLineThrough(java.lang.String value)
Sets one 'text-decoration' property to set line-through styles. |
void |
setTextOverline(java.lang.String value)
Sets one 'text-decoration' property to set overline styles. |
void |
setTextTransform(java.lang.String value)
Sets the value used to transform the text. |
void |
setTextUnderline(java.lang.String value)
Sets one 'text-decoration' property to set underline styles. |
void |
setVerticalAlign(java.lang.String value)
Sets the value of the vertical align property for inline elements. |
void |
setWhiteSpace(java.lang.String value)
Sets the white space property for block elements. |
void |
setWidows(java.lang.String value)
Sets the widows property. |
boolean |
showIfBlank()
Tests whether to show this frame even if it is empty, or all its data elements are empty. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public StyleHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
public java.lang.String getBackgroundAttachment()
DesignChoiceConstants
and can be one of:
public void setBackgroundAttachment(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
value
- the new background attachment
SemanticException
- if the value is not one of the above.public java.lang.String getBackgroundImage()
public void setBackgroundImage(java.lang.String value) throws SemanticException
value
- the new background image address
SemanticException
- if the property is lockedpublic java.lang.String getBackgroundRepeat()
DesignChoiceConstants
and can be one
of:
public void setBackgroundRepeat(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
value
- the new repeat pattern
SemanticException
- if the value is not one of the above.public java.lang.String getBorderBottomStyle()
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setBorderBottomStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
value
- the new style of the bottom line
SemanticException
- if the value is not one of the above.public java.lang.String getBorderLeftStyle()
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setBorderLeftStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
value
- the new style of the left line
SemanticException
- if the value is not one of the above.public java.lang.String getBorderRightStyle()
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setBorderRightStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
value
- the new style of the right line
SemanticException
- if the value is not one of the above.public java.lang.String getBorderTopStyle()
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
public void setBorderTopStyle(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
LINE_STYLE_NONE
LINE_STYLE_SOLID
LINE_STYLE_DOTTED
LINE_STYLE_DASHED
LINE_STYLE_DOUBLE
LINE_STYLE_GROOVE
LINE_STYLE_RIDGE
LINE_STYLE_INSET
LINE_STYLE_OUTSET
value
- the new style of the right line
SemanticException
- if the value is not one of the above.public boolean canShrink()
true
if can shrink, otherwise false
setCanShrink(boolean)
public void setCanShrink(boolean value) throws SemanticException
value
- true
if can shrink, false
not.
SemanticException
- if the property is lockedcanShrink()
public java.lang.String getStringFormat()
public java.lang.String getStringFormatCategory()
public void setStringFormat(java.lang.String pattern) throws SemanticException
pattern
- the pattern of a string forma
SemanticException
- if the property is lockedpublic void setStringFormatCategory(java.lang.String pattern) throws SemanticException
pattern
can be
one of:
DesignChoiceConstants.STRING_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.STRING_FORMAT_TYPE_UPPERCASE
DesignChoiceConstants.STRING_FORMAT_TYPE_LOWERCASE
DesignChoiceConstants.STRING_FORMAT_TYPE_CUSTOM
DesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE
DesignChoiceConstants.STRING_FORMAT_TYPE_ZIP_CODE_4
DesignChoiceConstants.STRING_FORMAT_TYPE_PHONE_NUMBER
DesignChoiceConstants.STRING_FORMAT_TYPE_SOCIAL_SECURITY_NUMBER
pattern
- the category of a string format
SemanticException
- if pattern
is not one of the above values.public java.lang.String getNumberFormat()
public java.lang.String getNumberFormatCategory()
public void setNumberFormat(java.lang.String pattern) throws SemanticException
pattern
- the pattern of a number format
SemanticException
- if the property is lockedpublic void setNumberFormatCategory(java.lang.String category) throws SemanticException
pattern
can be one of:
DesignChoiceConstants.NUMBER_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.NUMBER_FORMAT_TYPE_GENERAL_NUMBER
DesignChoiceConstants.NUMBER_FORMAT_TYPE_CURRENCY
DesignChoiceConstants.NUMBER_FORMAT_TYPE_FIXED
DesignChoiceConstants.NUMBER_FORMAT_TYPE_PERCENT
DesignChoiceConstants.NUMBER_FORMAT_TYPE_SCIENTIFIC
DesignChoiceConstants.NUMBER_FORMAT_TYPE_STANDARD
DesignChoiceConstants.NUMBER_FORMAT_TYPE_CUSTOM
category
- the category of a number format
SemanticException
- if category
is not one of the above values.public java.lang.String getDateTimeFormat()
public java.lang.String getDateTimeFormatCategory()
public void setDateTimeFormat(java.lang.String pattern) throws SemanticException
pattern
- the pattern of a date time format
SemanticException
- if the property is lockedpublic void setDateTimeFormatCategory(java.lang.String pattern) throws SemanticException
pattern
can be
one of:
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_UNFORMATTED
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_GENERAL_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_MUDIUM_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_DATE
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_LONG_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_MEDIUM_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_SHORT_TIME
DesignChoiceConstants.DATETIEM_FORMAT_TYPE_CUSTOM
pattern
- the category of a date-time format
SemanticException
- if pattern
is not one of the above values.public java.lang.String getDisplay()
DesignChoiceConstants
and can be one of:
DISPLAY_NONE
DISPLAY_INLINE
DISPLAY_BLOCK
public void setDisplay(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
DISPLAY_NONE
DISPLAY_INLINE
DISPLAY_BLOCK
value
- the new display value
SemanticException
- if the value is not one of the above.public java.lang.String getMasterPage()
setMasterPage(String)
public void setMasterPage(java.lang.String value) throws SemanticException
value
- the new master page name
SemanticException
- if the property is lockedgetMasterPage()
public java.lang.String getOrphans()
DesignChoiceConstants
:
ORPHANS_INHERIT
setOrphans(String)
public void setOrphans(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
ORPHANS_INHERIT
value
- the new orphans property
SemanticException
- if the value is not an integer or one of the above constants.getOrphans()
public java.lang.String getPageBreakAfter()
DesignChoiceConstants
:
PAGE_BREAK_AUTO
PAGE_BREAK_ALWAYS
PAGE_BREAK_AVOID
PAGE_BREAK_LEFT
PAGE_BREAK_RIGHT
PAGE_BREAK_INHERIT
public void setPageBreakAfter(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
PAGE_BREAK_AUTO
PAGE_BREAK_ALWAYS
PAGE_BREAK_AVOID
PAGE_BREAK_LEFT
PAGE_BREAK_RIGHT
PAGE_BREAK_INHERIT
value
- the new page break after property
SemanticException
- if the value is not pre-defined.public java.lang.String getPageBreakBefore()
DesignChoiceConstants
:
PAGE_BREAK_AUTO
PAGE_BREAK_ALWAYS
PAGE_BREAK_AVOID
PAGE_BREAK_LEFT
PAGE_BREAK_RIGHT
PAGE_BREAK_INHERIT
public void setPageBreakBefore(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
PAGE_BREAK_AUTO
PAGE_BREAK_ALWAYS
PAGE_BREAK_AVOID
PAGE_BREAK_LEFT
PAGE_BREAK_RIGHT
PAGE_BREAK_INHERIT
value
- the new page break before property
SemanticException
- if the value is not one of the above.public java.lang.String getPageBreakInside()
DesignChoiceConstants
:
PAGEBREAK_INSIDE_AVOID
PAGEBREAK_INSIDE_AUTO
PAGEBREAK_INSIDE_INHERIT
public void setPageBreakInside(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
PAGEBREAK_INSIDE_AVOID
PAGEBREAK_INSIDE_AUTO
PAGEBREAK_INSIDE_INHERIT
value
- the new page break inside property
SemanticException
- if the value is not one of the above.public boolean showIfBlank()
false
, the section is
automatically hidden when empty.
true
if show-if-blank, otherwise
false
setShowIfBlank(boolean)
public void setShowIfBlank(boolean value) throws SemanticException
value
- true
if show the frame. false
not.
SemanticException
- if the property is lockedshowIfBlank()
public java.lang.String getTextUnderline()
DesignChoiceConstants
:
TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
public void setTextUnderline(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
TEXT_UNDERLINE_NONE
TEXT_UNDERLINE_UNDERLINE
value
- the new text underline
SemanticException
- if the value is not pre-defined.public java.lang.String getTextOverline()
DesignChoiceConstants
:
TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
public void setTextOverline(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
TEXT_OVERLINE_NONE
TEXT_OVERLINE_OVERLINE
value
- the new text overline value
SemanticException
- if the value is not one of the above.public java.lang.String getTextLineThrough()
DesignChoiceConstants
:
TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
public void setTextLineThrough(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
TEXT_LINE_THROUGH_NONE
TEXT_LINE_THROUGH_LINE_THROUGH
value
- the new text line-through value
SemanticException
- if the value is not one of the above.public java.lang.String getTextAlign()
DesignChoiceConstants
:
TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
public void setTextAlign(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
TEXT_ALIGN_LEFT
TEXT_ALIGN_CENTER
TEXT_ALIGN_RIGHT
TEXT_ALIGN_JUSTIFY
value
- the new text align
SemanticException
- if the value is not one of the above.public java.lang.String getTextTransform()
DesignChoiceConstants
:
TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
public void setTextTransform(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
TRANSFORM_CAPITALIZE
TRANSFORM_UPPERCASE
TRANSFORM_LOWERCASE
TRANSFORM_NONE
value
- the new text transform
SemanticException
- if the value is not one of the above.public java.lang.String getVerticalAlign()
DesignChoiceConstants
and can
be one of:
public void setVerticalAlign(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be
one of:
value
- the new vertical align
SemanticException
- if the value is not one of the above.public java.lang.String getWhiteSpace()
DesignChoiceConstants
and can be one of:
WHITE_SPACE_NORMAL
WHITE_SPACE_PRE
WHITE_SPACE_NOWRAP
public void setWhiteSpace(java.lang.String value) throws SemanticException
DesignChoiceConstants
and can be one of:
WHITE_SPACE_NORMAL
WHITE_SPACE_PRE
WHITE_SPACE_NOWRAP
value
- the new white space
SemanticException
- if the value is not one of the above.public java.lang.String getWidows()
DesignChoiceConstants
:
WIDOWS_INHERIT
setWidows(String)
public void setWidows(java.lang.String value) throws SemanticException
DesignChoiceConstants
:
WIDOWS_INHERIT
value
- the new windows property
SemanticException
- if the value is not an integer or one of the above constants.getWidows()
public java.lang.String getMapTestExpr()
public void setMapTestExpr(java.lang.String value) throws SemanticException
value
- the value of new map test expression
SemanticException
- if the expression is invalid.public java.util.Iterator mapRulesIterator()
StructureHandle
that deal with a
MapRule
in the list.
public java.lang.String getHighlightTestExpr()
public void setHighlightTestExpr(java.lang.String value) throws SemanticException
value
- the value of new highlight test expression
SemanticException
- if the expression is invalid.public java.util.Iterator highlightRulesIterator()
HighlightRuleHandle
that deal with a
HighRule
.
public ColorHandle getColor()
public ColorHandle getBackgroundColor()
public ColorHandle getBorderTopColor()
public ColorHandle getBorderLeftColor()
public ColorHandle getBorderRightColor()
public ColorHandle getBorderBottomColor()
public DimensionHandle getBackGroundPositionX()
DesignChoiceConstatns
:
SECTION_ALIGN_LEFT
SECTION_ALIGN_CENTER
SECTION_ALIGN_RIGHT
public DimensionHandle getBackGroundPositionY()
DesignChoiceConstatns
:
BACKGROUND_POSITION_TOP
BACKGROUND_POSITION_CENTER
BACKGROUND_POSITION_BOTTOM
public DimensionHandle getLetterSpacing()
DesignChoiceConstatns
:
NORMAL_NORMAL
public DimensionHandle getLineHeight()
DesignChoiceConstatns
:
NORMAL_NORMAL
public DimensionHandle getTextIndent()
public DimensionHandle getWordSpacing()
DesignChoiceConstatns
:
NORMAL_NORMAL
public DimensionHandle getBorderTopWidth()
DesignChoiceConstatns
:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public DimensionHandle getBorderLeftWidth()
DesignChoiceConstatns
:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public DimensionHandle getBorderRightWidth()
DesignChoiceConstatns
:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public DimensionHandle getBorderBottomWidth()
DesignChoiceConstatns
:
LINE_WIDTH_THIN
LINE_WIDTH_MEDIUM
LINE_WIDTH_THICK
public DimensionHandle getMarginTop()
DesignChoiceConstatns
:
MARGIN_AUTO
public DimensionHandle getMarginRight()
DesignChoiceConstatns
:
MARGIN_AUTO
public DimensionHandle getMarginLeft()
DesignChoiceConstatns
:
MARGIN_AUTO
public DimensionHandle getMarginBottom()
DesignChoiceConstatns
:
MARGIN_AUTO
public DimensionHandle getPaddingTop()
public DimensionHandle getPaddingRight()
public DimensionHandle getPaddingLeft()
public DimensionHandle getPaddingBottom()
public DimensionHandle getFontSize()
public FontHandle getFontFamilyHandle()
FontHandle
public java.lang.String getFontWeight()
DesignChoiceConstants
:
FONT_WEIGHT_NORMAL
FONT_WEIGHT_BOLD
FONT_WEIGHT_BOLDER
FONT_WEIGHT_LIGHTER
FONT_WEIGHT_100
FONT_WEIGHT_200
FONT_WEIGHT_300
FONT_WEIGHT_400
FONT_WEIGHT_500
FONT_WEIGHT_600
FONT_WEIGHT_700
FONT_WEIGHT_800
FONT_WEIGHT_900
public void setFontWeight(java.lang.String fontWeight) throws SemanticException
DesignChoiceConstants
:
FONT_WEIGHT_NORMAL
FONT_WEIGHT_BOLD
FONT_WEIGHT_BOLDER
FONT_WEIGHT_LIGHTER
FONT_WEIGHT_100
FONT_WEIGHT_200
FONT_WEIGHT_300
FONT_WEIGHT_400
FONT_WEIGHT_500
FONT_WEIGHT_600
FONT_WEIGHT_700
FONT_WEIGHT_800
FONT_WEIGHT_900
fontWeight
- the new font weight
SemanticException
- if the input value is not one of the above.public java.lang.String getFontVariant()
DesignChoiceConstants
:
FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
public void setFontVariant(java.lang.String fontVariant) throws SemanticException
DesignChoiceConstants
:
FONT_VARIANT_NORMAL
FONT_VARIANT_SMALL_CAPS
fontVariant
- the new font variant.
SemanticException
- if the input value is not one of the above.public java.lang.String getFontStyle()
DesignChoiceConstants
:
FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
public void setFontStyle(java.lang.String fontStyle) throws SemanticException
DesignChoiceConstants
:
FONT_STYLE_NORMAL
FONT_STYLE_ITALIC
FONT_STYLE_OBLIQUE
fontStyle
- the new font style.
SemanticException
- if the input value is not one of the above.public boolean isPredefined()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |