| java.lang.Object
 org.jfree.report.elementfactory.ElementFactory
All known Subclasses: org.jfree.report.elementfactory.StaticDrawableElementFactory, org.jfree.report.elementfactory.DrawableURLFieldElementFactory, org.jfree.report.elementfactory.ComponentFieldElementFactory, org.jfree.report.elementfactory.AnchorFieldElementFactory, org.jfree.report.elementfactory.ShapeElementFactory, org.jfree.report.elementfactory.ImageElementFactory, org.jfree.report.elementfactory.TextElementFactory, org.jfree.report.elementfactory.DrawableFieldElementFactory, org.jfree.report.elementfactory.StaticDrawableURLElementFactory,
| ElementFactory | | abstract public class ElementFactory (Code) | | The class element factory is the base class for all Element Factories. Element factories can be used to create
predefined element types. The properties allow null values, if a property is null, it will not be defined. Undefined
properties can inherit their values from the element's parent bands or the default-stylesheet. Whether a property is
inheritable from the parent is defined in the style-key itself.
author:
Thomas Morgner |
| ElementFactory | | protected ElementFactory()(Code) | | Default Constructor.
|
| applyElementName | | protected void applyElementName(Element e)(Code) | | Applies the defined name to the created element.
Parameters:
e - the element which was created. |
| applyStyle | | protected void applyStyle(ElementStyleSheet style)(Code) | | Applies the style definition to the elements stylesheet.
Parameters:
style - the element stylesheet which should receive the style definition. |
| createElement | | abstract public Element createElement()(Code) | | Creates a new instance of the element. Override this method to return a concrete subclass of the element.
the newly generated instance of the element. |
| getAbsolutePosition | | public Point2D getAbsolutePosition()(Code) | | Returns the element's absolute position. This property is only used if the band containing this element uses a
canvas-layout strategy.
the element's absolute position.
See Also: ElementFactory.getX
See Also: ElementFactory.getY |
| getAvoidPagebreaks | | public Boolean getAvoidPagebreaks()(Code) | | Returns whether the layouter will try to avoid to generate pagebreaks inside this element. If the element does not
fit on the current page, it will be moved to the next page. Only if this next page does not have enough space to
hold this element, a pagebreak will be generated inside the element.
a boolean defining whether pagebreaks are allowed inside the box or null, if this property has been leftundefined. |
| getBackgroundColor | | public Color getBackgroundColor()(Code) | | Returns the defined background color of the box.
the background color or null, if undefined. |
| getBooleanValue | | protected static Boolean getBooleanValue(boolean b)(Code) | | Converts the given primitive boolean into a Boolean object.
Parameters:
b - the primitive value. Boolean.TRUE or Boolean.FALSE. |
| getBorderBottomColor | | public Color getBorderBottomColor()(Code) | | Returns the defined bottom border-color.
the color for the bottom edge or null, if the value should be left undefined here. |
| getBorderBottomLeftRadius | | public Dimension2D getBorderBottomLeftRadius()(Code) | | Returns the defined bottom-left border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded bottom-left corner.
the defined border-radius for the bottom-left corner of this element or null, if this property isundefined. |
| getBorderBottomLeftRadiusHeight | | public Float getBorderBottomLeftRadiusHeight()(Code) | | Returns height of the defined bottom-left border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have a rounded bottom-left corner.
the defined height of the border-radius for the bottom-left corner of this element or null, if thisproperty is undefined. |
| getBorderBottomLeftRadiusWidth | | public Float getBorderBottomLeftRadiusWidth()(Code) | | Returns width of the defined bottom-left border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have a rounded bottom-left corner.
the defined width of the border-radius for the bottom-left corner of this element or null, if this propertyis undefined. |
| getBorderBottomRightRadius | | public Dimension2D getBorderBottomRightRadius()(Code) | | Returns the defined bottom-right border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded bottom-right corner.
the defined border-radius for the bottom-right corner of this element or null, if this property isundefined. |
| getBorderBottomRightRadiusHeight | | public Float getBorderBottomRightRadiusHeight()(Code) | | Returns the height of the defined bottom-right border-radius for this element. If the border radius has a non-zero
width and height, the element's border will have a rounded bottom-right corner.
the height of the defined border-radius for the bottom-right corner of this element or null, if thisproperty is undefined. |
| getBorderBottomRightRadiusWidth | | public Float getBorderBottomRightRadiusWidth()(Code) | | Returns the width of the defined bottom-right border-radius for this element. If the border radius has a non-zero
width and height, the element's border will have a rounded bottom-right corner.
the width of the defined border-radius for the bottom-right corner of this element or null, if thisproperty is undefined. |
| getBorderBottomStyle | | public BorderStyle getBorderBottomStyle()(Code) | | Returns the defined bottom border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered.
the border style for the bottom edge or null, if the style should remain undefined. |
| getBorderBottomWidth | | public Float getBorderBottomWidth()(Code) | | Returns the defined left border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
the border width for the left edge or null if the property should be left undefined. |
| getBorderBreakColor | | public Color getBorderBreakColor()(Code) | | Returns the defined break border-color.
the color for the break edge or null, if the value should be left undefined here. |
| getBorderBreakStyle | | public BorderStyle getBorderBreakStyle()(Code) | | Returns the defined break border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered.
the border style for the break edge or null, if the style should remain undefined. |
| getBorderBreakWidth | | public Float getBorderBreakWidth()(Code) | | Returns the defined break border width of this box. A border width of zero effectively disables the border. A
number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height
(depending on the layout model of the band that contains this element).
The break border is applied to all inner border-edges of elements that got split on a pagebreak.
the width of the break edge of the border or null, if not defined. |
| getBorderColor | | public Color getBorderColor()(Code) | | Returns the defined global border-color. This property defines a short-hand property for all other border-color
properties.
the border-color for all borders or null, if no global color is defined. |
| getBorderLeftColor | | public Color getBorderLeftColor()(Code) | | Returns the defined left border-color.
the color for the left edge or null, if the value should be left undefined here. |
| getBorderLeftStyle | | public BorderStyle getBorderLeftStyle()(Code) | | Returns the defined left border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered.
the border style for the left edge or null, if the style should remain undefined. |
| getBorderLeftWidth | | public Float getBorderLeftWidth()(Code) | | Returns the defined left border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
the border width for the left edge or null if the property should be left undefined. |
| getBorderRadius | | public Dimension2D getBorderRadius()(Code) | | Returns the defined global border-radius for this element. If the border radius has a non-zero width and height,
the element's border will have rounded corners. This property is a short-hand property for all other border-radius
properties.
the defined border-radius for all corners of this element or null, if no global default is defined here. |
| getBorderRadiusHeight | | public Float getBorderRadiusHeight()(Code) | | Returns the defined global height of the border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have rounded corners. This property is a short-hand property for all other
border-radius properties.
the defined height of the border-radius for all corners of this element or null, if no global default isdefined here. |
| getBorderRadiusWidth | | public Float getBorderRadiusWidth()(Code) | | Returns the defined global width of the border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have rounded corners. This property is a short-hand property for all other
border-radius properties.
the defined width of the border-radius for all corners of this element or null, if no global default isdefined here. |
| getBorderRightColor | | public Color getBorderRightColor()(Code) | | Returns the defined right border-color.
the color for the right edge or null, if the value should be left undefined here. |
| getBorderRightStyle | | public BorderStyle getBorderRightStyle()(Code) | | Returns the defined right border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered.
the border style for the right edge or null, if the style should remain undefined. |
| getBorderRightWidth | | public Float getBorderRightWidth()(Code) | | Returns the defined right border width of this box. A border width of zero effectively disables the border. A
number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height
(depending on the layout model of the band that contains this element).
the border width for the right edge or null if the property should be left undefined. |
| getBorderStyle | | public BorderStyle getBorderStyle()(Code) | | Returns the defined global border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered. This property defines a short-hand property for all
other border-style properties.
the defined border-style or null, if the default should be used. |
| getBorderTopColor | | public Color getBorderTopColor()(Code) | | Returns the defined top border-color.
the color for the top edge or null, if the value should be left undefined here. |
| getBorderTopLeftRadius | | public Dimension2D getBorderTopLeftRadius()(Code) | | Returns the defined top-left border-radius for this element. If the border radius has a non-zero width and height,
the element's border will have a rounded top-left corner.
the defined border-radius for the top-left corner of this element or null, if this property is undefined. |
| getBorderTopLeftRadiusHeight | | public Float getBorderTopLeftRadiusHeight()(Code) | | Returns the height of the defined top-left border-radius for this element. If the border radius has a non-zero
width and height, the element's border will have a rounded top-left corner.
the height of the defined border-radius for the top-left corner of this element or null, if this propertyis undefined. |
| getBorderTopLeftRadiusWidth | | public Float getBorderTopLeftRadiusWidth()(Code) | | Returns the width of the defined top-left border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have a rounded top-left corner.
the width of the defined border-radius for the top-left corner of this element or null, if this property isundefined. |
| getBorderTopRightRadius | | public Dimension2D getBorderTopRightRadius()(Code) | | Returns the defined top-right border-radius for this element. If the border radius has a non-zero width and height,
the element's border will have a rounded top-right corner.
the defined border-radius for the top-right corner of this element or null, if this property is undefined. |
| getBorderTopRightRadiusHeight | | public Float getBorderTopRightRadiusHeight()(Code) | | Returns the height of the defined top-right border-radius for this element. If the border radius has a non-zero
width and height, the element's border will have a rounded top-right corner.
the height of the defined border-radius for the top-right corner of this element or null, if this propertyis undefined. |
| getBorderTopRightRadiusWidth | | public Float getBorderTopRightRadiusWidth()(Code) | | Returns the width of the defined top-right border-radius for this element. If the border radius has a non-zero
width and height, the element's border will have a rounded top-right corner.
the width of the defined border-radius for the top-right corner of this element or null, if this propertyis undefined. |
| getBorderTopStyle | | public BorderStyle getBorderTopStyle()(Code) | | Returns the defined top border-style for the element. If the border-style is set to NONE or undefined, the
border-size property will be ignored and no border is rendered.
the border style for the top edge or null, if the style should remain undefined. |
| getBorderTopWidth | | public Float getBorderTopWidth()(Code) | | Returns the defined top border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
the border width for the top edge or null if the property should be left undefined. |
| getBorderWidth | | public Float getBorderWidth()(Code) | | Returns the defined global border width of this box. A border width of zero effectively disables the border. A
number between 0 and -100 specifies the width as relative size given in percent of the parent's width or height
(depending on the layout model of the band that contains this element). This property defines a short-hand property
for all other border-width properties.
the defined border-width or null, if none is defined here. |
| getColor | | public Color getColor()(Code) | | Returns the text color for the new element.
the text color. |
| getDynamicHeight | | public Boolean getDynamicHeight()(Code) | | Returns whether the element's height should be adjusted automaticly.
the state of the dynamic feature or null, if the feature is undefined. |
| getFontSmooth | | public FontSmooth getFontSmooth()(Code) | | Returns the defined font smoothing (also known as text-aliasing) is applied to the element. If the font-smooth
property is undefined or auto, the actual value will be comptued depending on the element's font size.
the font-smooth constant or null, if this property is undefined. |
| getHRefTarget | | public String getHRefTarget()(Code) | | Returns the link target for this element. The link-target usually specifies the URL for a hyper-link.
the link target. |
| getHRefTitle | | public String getHRefTitle()(Code) | | Returns the defined HREF-Title. This title is only valid during the HTML export.
the href-title as string. |
| getHRefWindow | | public String getHRefWindow()(Code) | | Returns the 'window' parameter for hyperlink references. This property will only make sense in HTML-exports, as all
other export targets that support Hyperlinks will open up in a new window anyway.
the href-window string. |
| getHeight | | public Float getHeight()(Code) | | Returns the elements defined preferred height. A number between 0 and -100 specifies the width as relative size
given in percent of the parent's width or height (depending on the layout model of the band that contains this
element).
the preferred height or null, if left undefined. |
| getHorizontalAlignment | | public ElementAlignment getHorizontalAlignment()(Code) | | Returns the horizontal alignment for the content of this element.
the horizontal alignment. |
| getLayoutCachable | | public Boolean getLayoutCachable()(Code) | | Returns, whether the layout for the element is cachable. If you intend to modify the element's properties from
within a function, you should mark the element as non-cachable, or the layout may look funny.
This property is no longer used. This method will be removed in version 1.0.
the layout-cachable flag. |
| getMaximumHeight | | public Float getMaximumHeight()(Code) | | Returns the elements maximum height. The maximum height cannot have relative values.
the maximum height or null, if no maximum height is defined. |
| getMaximumWidth | | public Float getMaximumWidth()(Code) | | Returns the elements maximum width. The maximum width cannot have relative values.
the maximum width or null, if no maximum width is defined. |
| getMinimumHeight | | public Float getMinimumHeight()(Code) | | Returns the elements minimum height. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
the minimum height or null, if no minimum height is defined. |
| getMinimumWidth | | public Float getMinimumWidth()(Code) | | Returns the elements minimum width. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
the minimum width or null, if no minimum width is defined. |
| getName | | public String getName()(Code) | | Returns the name of the new element.
the name of the element. |
| getOrphans | | public Integer getOrphans()(Code) | | Returns the defined number of orphan-lines in this element. This avoids pagebreaks inside the last number of lines
of a paragraph. If a pagebreak would occur inside the orphan-segment, the whole number of orphan lines or the whole
box will be shifted to the next page.
the number of orphan-lines that control the pagebreak inside the paragraph. |
| getOverflowX | | public Boolean getOverflowX()(Code) | | Returns, whether text contained in this element will overflow horizontally. This will generate overlapping text in
the pageable outputs without increasing the total size of the element. Activating this property may cause rendering
artifacts.
a boolean whether text can overflow the box boundaries or null, if this property is left undefined. |
| getOverflowY | | public Boolean getOverflowY()(Code) | | Returns, whether text contained in this element will overflow vertically. This will generate overlapping text in
the pageable outputs without increasing the total size of the element. Activating this property may cause rendering
artifacts.
a boolean whether text can overflow the box boundaries or null, if this property is left undefined. |
| getPadding | | public Float getPadding()(Code) | | Returns the defined global padding of this box. Padding defines the empty area between the border and the content
of an element. This property defines a short-hand property for all other padding properties. Paddings cannot have
relative sizes.
the padding or null, if none is defined here. |
| getPaddingBottom | | public Float getPaddingBottom()(Code) | | Returns the defined bottom padding of this box. Padding defines the empty area between the border and the content
of an element. Paddings cannot have relative sizes.
the padding or null, if the padding remains undefined here. |
| getPaddingLeft | | public Float getPaddingLeft()(Code) | | Returns the defined left padding of this box. Padding defines the empty area between the border and the content of
an element. Paddings cannot have relative sizes.
the padding or null, if the padding remains undefined here. |
| getPaddingRight | | public Float getPaddingRight()(Code) | | Returns the defined right padding of this box. Padding defines the empty area between the border and the content of
an element. Paddings cannot have relative sizes.
the padding or null, if the padding remains undefined here. |
| getPaddingTop | | public Float getPaddingTop()(Code) | | Returns the defined top padding of this box. Padding defines the empty area between the border and the content of
an element. Paddings cannot have relative sizes.
the padding or null, if the padding remains undefined here. |
| getVerticalAlignment | | public ElementAlignment getVerticalAlignment()(Code) | | Returns the vertical alignment for the content of this element.
the vertical alignment. |
| getVisible | | public Boolean getVisible()(Code) | | Returns, whether the element will be visible.
the visibility of the element. |
| getWidows | | public Integer getWidows()(Code) | | Returns the defined number of widow-lines in this element. This avoids pagebreaks inside the first number of lines
of a paragraph. If a pagebreak would occur inside the widow-segment, the whole box will be shifted to the next
page.
the number of widow-lines that control the pagebreak inside the paragraph. |
| getWidth | | public Float getWidth()(Code) | | Returns the elements defined preferred width. A number between 0 and -100 specifies the width as relative size
given in percent of the parent's width or height (depending on the layout model of the band that contains this
element).
the preferred width or null, if left undefined. |
| getX | | public Float getX()(Code) | | Returns the elements defined absolute horizontal position for the canvas-layout. The position is relative to the
parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size
given in percent of the parent's width or height (depending on the layout model of the band that contains this
element).
the elements horizontal position or null, if not defined. |
| getY | | public Float getY()(Code) | | Returns the elements defined absolute vertical position for the canvas-layout. The position is relative to the
parents upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size
given in percent of the parent's width or height (depending on the layout model of the band that contains this
element).
the elements vertical position or null, if not defined. |
| setAbsolutePosition | | public void setAbsolutePosition(Point2D absolutePosition)(Code) | | Returns the element's absolute position. This property is only used if the band containing this element uses a
canvas-layout strategy.
Parameters:
absolutePosition - the element's absolute position.
See Also: ElementFactory.setX(Float)
See Also: ElementFactory.setY(Float) |
| setAvoidPagebreaks | | public void setAvoidPagebreaks(Boolean avoidPagebreaks)(Code) | | Defines whether the layouter will try to avoid to generate pagebreaks inside this element. If the element does not
fit on the current page, it will be moved to the next page. Only if this next page does not have enough space to
hold this element, a pagebreak will be generated inside the element.
Parameters:
avoidPagebreaks - a boolean defining whether pagebreaks are allowed inside the box or null, if this propertyshould be left undefined. |
| setBackgroundColor | | public void setBackgroundColor(Color backgroundColor)(Code) | | Defines the background color of the box.
Parameters:
backgroundColor - the background color or null, if undefined. |
| setBorderBottomColor | | public void setBorderBottomColor(Color borderBottomColor)(Code) | | Defines the bottom border-color.
Parameters:
borderBottomColor - the color for the bottom edge or null, if the value should be left undefined here. |
| setBorderBottomLeftRadius | | public void setBorderBottomLeftRadius(Dimension2D borderRadius)(Code) | | Defines the bottom-left border-radius for this element. If the border radius has a non-zero width and height, the
element's border will have a rounded bottom-left corner.
Parameters:
borderRadius - the defined border-radius for the bottom-left corner of this element or null, if this propertyshould be undefined. |
| setBorderBottomLeftRadiusHeight | | public void setBorderBottomLeftRadiusHeight(Float borderBottomLeftRadiusHeight)(Code) | | Defines height of the bottom-left border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded bottom-left corner.
Parameters:
borderBottomLeftRadiusHeight - the height of the defined border-radius for the bottom-left corner of thiselement or null, if this property should be undefined. |
| setBorderBottomLeftRadiusWidth | | public void setBorderBottomLeftRadiusWidth(Float borderBottomLeftRadiusWidth)(Code) | | Defines width of the bottom-left border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded bottom-left corner.
Parameters:
borderBottomLeftRadiusWidth - the width of the defined border-radius for the bottom-left corner of thiselement or null, if this property should be undefined. |
| setBorderBottomRightRadius | | public void setBorderBottomRightRadius(Dimension2D borderRadius)(Code) | | Defines the bottom-right border-radius for this element. If the border radius has a non-zero width and height, the
element's border will have a rounded bottom-right corner.
Parameters:
borderRadius - the defined border-radius for the bottom-right corner of this element or null, if this propertyshould be undefined. |
| setBorderBottomRightRadiusHeight | | public void setBorderBottomRightRadiusHeight(Float borderBottomRightRadiusHeight)(Code) | | Defines the height of the bottom-right border-radius for this element. If the border radius has a non-zero width
and height, the element's border will have a rounded bottom-right corner.
Parameters:
borderBottomRightRadiusHeight - the height of the defined border-radius for the bottom-right corner of thiselement or null, if this property should be undefined. |
| setBorderBottomRightRadiusWidth | | public void setBorderBottomRightRadiusWidth(Float borderBottomRightRadiusWidth)(Code) | | Defines the width of the bottom-right border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded bottom-right corner.
Parameters:
borderBottomRightRadiusWidth - the width of the defined border-radius for the bottom-right corner of thiselement or null, if this property should be undefined. |
| setBorderBottomStyle | | public void setBorderBottomStyle(BorderStyle borderBottomStyle)(Code) | | Defines the bottom border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered.
Parameters:
borderBottomStyle - the border style for the bottom edge or null, if the style should remain undefined. |
| setBorderBottomWidth | | public void setBorderBottomWidth(Float borderBottomWidth)(Code) | | Defines the bottom border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
Parameters:
borderBottomWidth - the border width for the bottom edge or null if the property should be left undefined. |
| setBorderBreakColor | | public void setBorderBreakColor(Color borderBreakColor)(Code) | | Defines the break border-color.
Parameters:
borderBreakColor - the color for the break edge or null, if the value should be left undefined here. |
| setBorderBreakStyle | | public void setBorderBreakStyle(BorderStyle borderBreakStyle)(Code) | | Defines the break border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered.
Parameters:
borderBreakStyle - the border style for the break edge or null, if the style should remain undefined. |
| setBorderBreakWidth | | public void setBorderBreakWidth(Float borderBreakWidth)(Code) | | Defines the break border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
The break border is applied to all inner border-edges of elements that got split on a pagebreak.
Parameters:
borderBreakWidth - the width of the break edge of the border or null, if not defined. |
| setBorderColor | | public void setBorderColor(Color borderColor)(Code) | | Defines the global border-color. This property defines a short-hand property for all other border-color
properties.
Parameters:
borderColor - the defined color for all borders or null, if no global color is defined. |
| setBorderLeftColor | | public void setBorderLeftColor(Color borderLeftColor)(Code) | | Defines the left border-color.
Parameters:
borderLeftColor - the color for the left edge or null, if the value should be left undefined here. |
| setBorderLeftStyle | | public void setBorderLeftStyle(BorderStyle borderLeftStyle)(Code) | | Defines the left border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered.
Parameters:
borderLeftStyle - the border style for the left edge or null, if the style should remain undefined. |
| setBorderLeftWidth | | public void setBorderLeftWidth(Float borderLeftWidth)(Code) | | Defines the left border width of this box. A border width of zero effectively disables the border. A number between
0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the
layout model of the band that contains this element).
Parameters:
borderLeftWidth - the border width for the left edge or null if the property should be left undefined. |
| setBorderRadius | | public void setBorderRadius(Dimension2D borderRadius)(Code) | | Defines the global border-radius for this element. If the border radius has a non-zero width and height, the
element's border will have rounded corners. This property is a short-hand property for all other border-radius
properties.
Parameters:
borderRadius - the defined border-radius for all corners of this element or null, if no global default shouldbe defined here. |
| setBorderRadiusHeight | | public void setBorderRadiusHeight(Float borderRadiusHeight)(Code) | | Defines the global height of the border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have rounded corners. This property is a short-hand property for all other
border-radius properties.
Parameters:
borderRadiusHeight - the defined height of the border-radius for all corners of this element or null, if noglobal default should be defined here. |
| setBorderRadiusWidth | | public void setBorderRadiusWidth(Float borderRadiusWidth)(Code) | | Defines the global width of the border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have rounded corners. This property is a short-hand property for all other
border-radius properties.
Parameters:
borderRadiusWidth - the defined width of the border-radius for all corners of this element or null, if noglobal default should be defined here. |
| setBorderRightColor | | public void setBorderRightColor(Color borderRightColor)(Code) | | Defines the right border-color.
Parameters:
borderRightColor - the color for the right edge or null, if the value should be left undefined here. |
| setBorderRightStyle | | public void setBorderRightStyle(BorderStyle borderRightStyle)(Code) | | Defines the right border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered.
Parameters:
borderRightStyle - the border style for the right edge or null, if the style should remain undefined. |
| setBorderRightWidth | | public void setBorderRightWidth(Float borderRightWidth)(Code) | | Defines the right border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element).
Parameters:
borderRightWidth - the border width for the right edge or null if the property should be left undefined. |
| setBorderStyle | | public void setBorderStyle(BorderStyle borderStyle)(Code) | | Defines the global border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered. This property defines a short-hand property for all other
border-style properties.
Parameters:
borderStyle - the defined border-style or null, if none is defined here. |
| setBorderTopColor | | public void setBorderTopColor(Color borderTopColor)(Code) | | Defines the top border-color.
Parameters:
borderTopColor - the color for the top edge or null, if the value should be left undefined here. |
| setBorderTopLeftRadius | | public void setBorderTopLeftRadius(Dimension2D borderRadius)(Code) | | Defines the top-left border-radius for this element. If the border radius has a non-zero width and height, the
element's border will have a rounded top-left corner.
Parameters:
borderRadius - the defined border-radius for the top-left corner of this element or null, if this propertyshould be undefined. |
| setBorderTopLeftRadiusHeight | | public void setBorderTopLeftRadiusHeight(Float borderTopLeftRadiusHeight)(Code) | | Defines the height of the top-left border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded top-left corner.
Parameters:
borderTopLeftRadiusHeight - the height of the defined border-radius for the top-left corner of this element ornull, if this property should be undefined. |
| setBorderTopLeftRadiusWidth | | public void setBorderTopLeftRadiusWidth(Float borderTopLeftRadiusWidth)(Code) | | Defines the width of the top-left border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded top-left corner.
Parameters:
borderTopLeftRadiusWidth - the width of the defined border-radius for the top-left corner of this element ornull, if this property should be undefined. |
| setBorderTopRightRadius | | public void setBorderTopRightRadius(Dimension2D borderRadius)(Code) | | Defines the top-right border-radius for this element. If the border radius has a non-zero width and height, the
element's border will have a rounded top-right corner.
Parameters:
borderRadius - the defined border-radius for the top-right corner of this element or null, if this propertyshould be undefined. |
| setBorderTopRightRadiusHeight | | public void setBorderTopRightRadiusHeight(Float borderTopRightRadiusHeight)(Code) | | Defines the height of the top-right border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded top-right corner.
Parameters:
borderTopRightRadiusHeight - the height of the defined border-radius for the top-right corner of this elementor null, if this property should be undefined. |
| setBorderTopRightRadiusWidth | | public void setBorderTopRightRadiusWidth(Float borderTopRightRadiusWidth)(Code) | | Defines the width of the top-right border-radius for this element. If the border radius has a non-zero width and
height, the element's border will have a rounded top-right corner.
Parameters:
borderTopRightRadiusWidth - the width of the defined border-radius for the top-right corner of this element ornull, if this property should be undefined. |
| setBorderTopStyle | | public void setBorderTopStyle(BorderStyle borderTopStyle)(Code) | | Defines the top border-style for the element. If the border-style is set to NONE or undefined, the border-size
property will be ignored and no border is rendered.
Parameters:
borderTopStyle - the border style for the top edge or null, if the style should remain undefined. |
| setBorderTopWidth | | public void setBorderTopWidth(Float borderTopWidth)(Code) | | Defines the top border width of this box. A border width of zero effectively disables the border. A number between
0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending on the
layout model of the band that contains this element).
Parameters:
borderTopWidth - the border width for the top edge or null if the property should be left undefined. |
| setBorderWidth | | public void setBorderWidth(Float borderWidth)(Code) | | Defines the global border width of this box. A border width of zero effectively disables the border. A number
between 0 and -100 specifies the width as relative size given in percent of the parent's width or height (depending
on the layout model of the band that contains this element). This property defines a short-hand property for all
other border-width properties.
Parameters:
borderWidth - the defined border width or null, if the default should be used. |
| setColor | | public void setColor(Color color)(Code) | | Defines the text color for the new element.
Parameters:
color - the text color. |
| setDynamicHeight | | public void setDynamicHeight(Boolean dynamicHeight)(Code) | | Defines whether the element's height should be adjusted automaticly.
Parameters:
dynamicHeight - the new value of the elements dynamic height feature. |
| setFontSmooth | | public void setFontSmooth(FontSmooth fontSmooth)(Code) | | Defines, whether font smoothing (also known as text-aliasing) is applied to the element. If the font-smooth
property is undefined or auto, the actual value will be comptued depending on the element's font size.
Parameters:
fontSmooth - the font-smooth constant or null, if this property should be left undefined. |
| setHRefTarget | | public void setHRefTarget(String hRefTarget)(Code) | | Defines the link target for the element. The link-target usually specifies the URL for a hyper-link.
Parameters:
hRefTarget - the link target. |
| setHRefTitle | | public void setHRefTitle(String hRefTitle)(Code) | | Defines the defined HREF-Title. This title is only valid during the HTML export.
Parameters:
hRefTitle - the href-title as string. |
| setHRefWindow | | public void setHRefWindow(String hRefWindow)(Code) | | Defines the 'window' parameter for hyperlink references. This property will only make sense in HTML-exports, as all
other export targets that support Hyperlinks will open up in a new window anyway.
Parameters:
hRefWindow - the href-window string. |
| setHeight | | public void setHeight(Float height)(Code) | | Defines the elements preferred height. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
height - the preferred height or null, if left undefined. |
| setHorizontalAlignment | | public void setHorizontalAlignment(ElementAlignment horizontalAlignment)(Code) | | Defines the horizontal alignment for the content of this element.
Parameters:
horizontalAlignment - the vertical alignment. |
| setLayoutCachable | | public void setLayoutCachable(Boolean layoutCachable)(Code) | | Returns, whether the layout for the element is cachable. If you intend to modify the element's properties from
within a function, you should mark the element as non-cachable, or the layout may look funny. Set this value to
null if this value should be inherited from the parent.
This property is no longer used. This method will be removed in version 1.0.
Parameters:
layoutCachable - the layout-cachable flag. |
| setMaximumHeight | | public void setMaximumHeight(Float maximumHeight)(Code) | | Defines the elements maximum height. The maximum height cannot have relative values.
Parameters:
maximumHeight - the maximum width or null, if no maximum height should be defined. |
| setMaximumWidth | | public void setMaximumWidth(Float maximumWidth)(Code) | | Defines the elements maximum width. The maximum width cannot have relative values.
Parameters:
maximumWidth - the maximum width or null, if no maximum width should be defined. |
| setMinimumHeight | | public void setMinimumHeight(Float minimumHeight)(Code) | | Defines the elements minimum height. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
minimumHeight - the minimum height or null, to leave this property undefined. |
| setMinimumWidth | | public void setMinimumWidth(Float minimumWidth)(Code) | | Defines the elements minimum width. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
minimumWidth - the minimum width or null, to leave this property undefined. |
| setName | | public void setName(String name)(Code) | | Defines the name of the element. If the name is null, the default (anonymous) name will be used.
Parameters:
name - the element name. |
| setOrphans | | public void setOrphans(Integer orphans)(Code) | | Defines the number of orphan-lines in this element. This avoids pagebreaks inside the last number of lines of a
paragraph. If a pagebreak would occur inside the orphan-segment, the whole number of orphan lines or the whole box
will be shifted to the next page.
Parameters:
orphans - the number of orphan-lines that control the pagebreak inside the paragraph. |
| setOverflowX | | public void setOverflowX(Boolean overflowX)(Code) | | Defines, whether text contained in this element will overflow horizontally. This will generate overlapping text in
the pageable outputs without increasing the total size of the element. Activating this property may cause rendering
artifacts.
Parameters:
overflowX - defines, whether text can overflow the box boundaries or null, to leave this property undefined. |
| setOverflowY | | public void setOverflowY(Boolean overflowY)(Code) | | Defines, whether text contained in this element will overflow vertically. This will generate overlapping text in
the pageable outputs without increasing the total size of the element. Activating this property may cause rendering
artifacts.
Parameters:
overflowY - defines, whether text can overflow the box boundaries or null, to leave this property undefined. |
| setPadding | | public void setPadding(Float padding)(Code) | | Defines the global padding of this box. Padding defines the empty area between the border and the content of an
element. This property defines a short-hand property for all other padding properties. Paddings cannot have
relative sizes.
Parameters:
padding - the padding or null, if the default should be used. |
| setPaddingBottom | | public void setPaddingBottom(Float paddingBottom)(Code) | | Defines the bottom padding of this box. Padding defines the empty area between the border and the content of an
element. Paddings cannot have relative sizes.
Parameters:
paddingBottom - the padding or null, if the padding remains undefined here. |
| setPaddingLeft | | public void setPaddingLeft(Float paddingLeft)(Code) | | Defines the left padding of this box. Padding defines the empty area between the border and the content of an
element. Paddings cannot have relative sizes.
Parameters:
paddingLeft - the padding or null, if the padding remains undefined here. |
| setPaddingRight | | public void setPaddingRight(Float paddingRight)(Code) | | Defines the right padding of this box. Padding defines the empty area between the border and the content of an
element. Paddings cannot have relative sizes.
Parameters:
paddingRight - the padding or null, if the padding remains undefined here. |
| setPaddingTop | | public void setPaddingTop(Float paddingTop)(Code) | | Defines the top padding of this box. Padding defines the empty area between the border and the content of an
element. Paddings cannot have relative sizes.
Parameters:
paddingTop - the padding or null, if the padding remains undefined here. |
| setVerticalAlignment | | public void setVerticalAlignment(ElementAlignment verticalAlignment)(Code) | | Defines the vertical alignment for the content of this element.
Parameters:
verticalAlignment - the vertical alignment. |
| setVisible | | public void setVisible(Boolean visible)(Code) | | Defines, whether the element will be visible.
Parameters:
visible - the visibility flag of the element. |
| setWidows | | public void setWidows(Integer widows)(Code) | | Defines the number of widow-lines in this element. This avoids pagebreaks inside the first number of lines of a
paragraph. If a pagebreak would occur inside the widow-segment, the whole box will be shifted to the next page.
Parameters:
widows - the number of widow-lines that control the pagebreak inside the paragraph. |
| setWidth | | public void setWidth(Float width)(Code) | | Defines the elements preferred width. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
width - the preferred width or null, if left undefined. |
| setX | | public void setX(Float x)(Code) | | Defines the elements absolute horizontal position for the canvas-layout. The position is relative to the parents
upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
x - the elements horizontal position or null, if not defined. |
| setY | | public void setY(Float y)(Code) | | Defines the elements absolute vertical position for the canvas-layout. The position is relative to the parents
upper left corner of the content-area. A number between 0 and -100 specifies the width as relative size given in
percent of the parent's width or height (depending on the layout model of the band that contains this element).
Parameters:
y - the elements vertical position or null, if not defined. |
|
|