public abstract class ElementFactory extends Object
Modifier and Type | Method and Description |
---|---|
abstract Element |
createElement()
Creates a new instance of the element.
|
Point2D |
getAbsolutePosition()
Returns the element's absolute position.
|
Boolean |
getAvoidPagebreaks()
Returns whether the layouter will try to avoid to generate pagebreaks inside this element.
|
Color |
getBackgroundColor()
Returns the defined background color of the box.
|
Color |
getBorderBottomColor()
Returns the defined bottom border-color.
|
Dimension2D |
getBorderBottomLeftRadius()
Returns the defined bottom-left border-radius for this element.
|
Float |
getBorderBottomLeftRadiusHeight()
Returns height of the defined bottom-left border-radius for this element.
|
Float |
getBorderBottomLeftRadiusWidth()
Returns width of the defined bottom-left border-radius for this element.
|
Dimension2D |
getBorderBottomRightRadius()
Returns the defined bottom-right border-radius for this element.
|
Float |
getBorderBottomRightRadiusHeight()
Returns the height of the defined bottom-right border-radius for this element.
|
Float |
getBorderBottomRightRadiusWidth()
Returns the width of the defined bottom-right border-radius for this element.
|
BorderStyle |
getBorderBottomStyle()
Returns the defined bottom border-style for the element.
|
Float |
getBorderBottomWidth()
Returns the defined left border width of this box.
|
Color |
getBorderBreakColor()
Returns the defined break border-color.
|
BorderStyle |
getBorderBreakStyle()
Returns the defined break border-style for the element.
|
Float |
getBorderBreakWidth()
Returns the defined break border width of this box.
|
Color |
getBorderColor()
Returns the defined global border-color.
|
Color |
getBorderLeftColor()
Returns the defined left border-color.
|
BorderStyle |
getBorderLeftStyle()
Returns the defined left border-style for the element.
|
Float |
getBorderLeftWidth()
Returns the defined left border width of this box.
|
Dimension2D |
getBorderRadius()
Returns the defined global border-radius for this element.
|
Float |
getBorderRadiusHeight()
Returns the defined global height of the border-radius for this element.
|
Float |
getBorderRadiusWidth()
Returns the defined global width of the border-radius for this element.
|
Color |
getBorderRightColor()
Returns the defined right border-color.
|
BorderStyle |
getBorderRightStyle()
Returns the defined right border-style for the element.
|
Float |
getBorderRightWidth()
Returns the defined right border width of this box.
|
BorderStyle |
getBorderStyle()
Returns the defined global border-style for the element.
|
Color |
getBorderTopColor()
Returns the defined top border-color.
|
Dimension2D |
getBorderTopLeftRadius()
Returns the defined top-left border-radius for this element.
|
Float |
getBorderTopLeftRadiusHeight()
Returns the height of the defined top-left border-radius for this element.
|
Float |
getBorderTopLeftRadiusWidth()
Returns the width of the defined top-left border-radius for this element.
|
Dimension2D |
getBorderTopRightRadius()
Returns the defined top-right border-radius for this element.
|
Float |
getBorderTopRightRadiusHeight()
Returns the height of the defined top-right border-radius for this element.
|
Float |
getBorderTopRightRadiusWidth()
Returns the width of the defined top-right border-radius for this element.
|
BorderStyle |
getBorderTopStyle()
Returns the defined top border-style for the element.
|
Float |
getBorderTopWidth()
Returns the defined top border width of this box.
|
Float |
getBorderWidth()
Returns the defined global border width of this box.
|
Color |
getColor()
Returns the text color for the new element.
|
Boolean |
getDynamicHeight()
Returns whether the element's height should be adjusted automaticly.
|
FontSmooth |
getFontSmooth()
Returns the defined font smoothing (also known as text-aliasing) is applied to the element.
|
Float |
getHeight()
Returns the elements defined preferred height.
|
ElementAlignment |
getHorizontalAlignment()
Returns the horizontal alignment for the content of this element.
|
String |
getHRefTarget()
Returns the link target for this element.
|
String |
getHRefTitle()
Returns the defined HREF-Title.
|
String |
getHRefWindow()
Returns the 'window' parameter for hyperlink references.
|
Boolean |
getLayoutCachable()
Deprecated.
The layout cachable flag is no longer used.
|
Float |
getMaximumHeight()
Returns the elements maximum height.
|
Dimension2D |
getMaximumSize()
Returns the element's maximum size.
|
Float |
getMaximumWidth()
Returns the elements maximum width.
|
Float |
getMinimumHeight()
Returns the elements minimum height.
|
Dimension2D |
getMinimumSize()
Returns the element's minimum size.
|
Float |
getMinimumWidth()
Returns the elements minimum width.
|
String |
getName()
Returns the name of the new element.
|
Integer |
getOrphans()
Returns the defined number of orphan-lines in this element.
|
Boolean |
getOverflowX()
Returns, whether text contained in this element will overflow horizontally.
|
Boolean |
getOverflowY()
Returns, whether text contained in this element will overflow vertically.
|
Float |
getPadding()
Returns the defined global padding of this box.
|
Float |
getPaddingBottom()
Returns the defined bottom padding of this box.
|
Float |
getPaddingLeft()
Returns the defined left padding of this box.
|
Float |
getPaddingRight()
Returns the defined right padding of this box.
|
Float |
getPaddingTop()
Returns the defined top padding of this box.
|
Dimension2D |
getPreferredSize()
Returns the element's preferred size.
|
Boolean |
getUseMinChunkWidth() |
ElementAlignment |
getVerticalAlignment()
Returns the vertical alignment for the content of this element.
|
Boolean |
getVisible()
Returns, whether the element will be visible.
|
Boolean |
getWidowOrphanOptOut() |
Integer |
getWidows()
Returns the defined number of widow-lines in this element.
|
Float |
getWidth()
Returns the elements defined preferred width.
|
Float |
getX()
Returns the elements defined absolute horizontal position for the canvas-layout.
|
Float |
getY()
Returns the elements defined absolute vertical position for the canvas-layout.
|
void |
setAbsolutePosition(Point2D absolutePosition)
Returns the element's absolute position.
|
void |
setAvoidPagebreaks(Boolean avoidPagebreaks)
Defines whether the layouter will try to avoid to generate pagebreaks inside this element.
|
void |
setBackgroundColor(Color backgroundColor)
Defines the background color of the box.
|
void |
setBorderBottomColor(Color borderBottomColor)
Defines the bottom border-color.
|
void |
setBorderBottomLeftRadius(Dimension2D borderRadius)
Defines the bottom-left border-radius for this element.
|
void |
setBorderBottomLeftRadiusHeight(Float borderBottomLeftRadiusHeight)
Defines height of the bottom-left border-radius for this element.
|
void |
setBorderBottomLeftRadiusWidth(Float borderBottomLeftRadiusWidth)
Defines width of the bottom-left border-radius for this element.
|
void |
setBorderBottomRightRadius(Dimension2D borderRadius)
Defines the bottom-right border-radius for this element.
|
void |
setBorderBottomRightRadiusHeight(Float borderBottomRightRadiusHeight)
Defines the height of the bottom-right border-radius for this element.
|
void |
setBorderBottomRightRadiusWidth(Float borderBottomRightRadiusWidth)
Defines the width of the bottom-right border-radius for this element.
|
void |
setBorderBottomStyle(BorderStyle borderBottomStyle)
Defines the bottom border-style for the element.
|
void |
setBorderBottomWidth(Float borderBottomWidth)
Defines the bottom border width of this box.
|
void |
setBorderBreakColor(Color borderBreakColor)
Defines the break border-color.
|
void |
setBorderBreakStyle(BorderStyle borderBreakStyle)
Defines the break border-style for the element.
|
void |
setBorderBreakWidth(Float borderBreakWidth)
Defines the break border width of this box.
|
void |
setBorderColor(Color borderColor)
Defines the global border-color.
|
void |
setBorderLeftColor(Color borderLeftColor)
Defines the left border-color.
|
void |
setBorderLeftStyle(BorderStyle borderLeftStyle)
Defines the left border-style for the element.
|
void |
setBorderLeftWidth(Float borderLeftWidth)
Defines the left border width of this box.
|
void |
setBorderRadius(Dimension2D borderRadius)
Defines the global border-radius for this element.
|
void |
setBorderRadiusHeight(Float borderRadiusHeight)
Defines the global height of the border-radius for this element.
|
void |
setBorderRadiusWidth(Float borderRadiusWidth)
Defines the global width of the border-radius for this element.
|
void |
setBorderRightColor(Color borderRightColor)
Defines the right border-color.
|
void |
setBorderRightStyle(BorderStyle borderRightStyle)
Defines the right border-style for the element.
|
void |
setBorderRightWidth(Float borderRightWidth)
Defines the right border width of this box.
|
void |
setBorderStyle(BorderStyle borderStyle)
Defines the global border-style for the element.
|
void |
setBorderTopColor(Color borderTopColor)
Defines the top border-color.
|
void |
setBorderTopLeftRadius(Dimension2D borderRadius)
Defines the top-left border-radius for this element.
|
void |
setBorderTopLeftRadiusHeight(Float borderTopLeftRadiusHeight)
Defines the height of the top-left border-radius for this element.
|
void |
setBorderTopLeftRadiusWidth(Float borderTopLeftRadiusWidth)
Defines the width of the top-left border-radius for this element.
|
void |
setBorderTopRightRadius(Dimension2D borderRadius)
Defines the top-right border-radius for this element.
|
void |
setBorderTopRightRadiusHeight(Float borderTopRightRadiusHeight)
Defines the height of the top-right border-radius for this element.
|
void |
setBorderTopRightRadiusWidth(Float borderTopRightRadiusWidth)
Defines the width of the top-right border-radius for this element.
|
void |
setBorderTopStyle(BorderStyle borderTopStyle)
Defines the top border-style for the element.
|
void |
setBorderTopWidth(Float borderTopWidth)
Defines the top border width of this box.
|
void |
setBorderWidth(Float borderWidth)
Defines the global border width of this box.
|
void |
setColor(Color color)
Defines the text color for the new element.
|
void |
setDynamicHeight(Boolean dynamicHeight)
Defines whether the element's height should be adjusted automaticly.
|
void |
setFontSmooth(FontSmooth fontSmooth)
Defines, whether font smoothing (also known as text-aliasing) is applied to the element.
|
void |
setHeight(Float height)
Defines the elements preferred height.
|
void |
setHorizontalAlignment(ElementAlignment horizontalAlignment)
Defines the horizontal alignment for the content of this element.
|
void |
setHRefTarget(String hRefTarget)
Defines the link target for the element.
|
void |
setHRefTitle(String hRefTitle)
Defines the defined HREF-Title.
|
void |
setHRefWindow(String hRefWindow)
Defines the 'window' parameter for hyperlink references.
|
void |
setLayoutCachable(Boolean layoutCachable)
Deprecated.
The layout cachable flag is no longer used.
|
void |
setMaximumHeight(Float maximumHeight)
Defines the elements maximum height.
|
void |
setMaximumSize(Dimension2D maximumSize)
Defines the element's maximum size.
|
void |
setMaximumWidth(Float maximumWidth)
Defines the elements maximum width.
|
void |
setMinimumHeight(Float minimumHeight)
Defines the elements minimum height.
|
void |
setMinimumSize(Dimension2D minimumSize)
Defines the element's minimum size.
|
void |
setMinimumWidth(Float minimumWidth)
Defines the elements minimum width.
|
void |
setName(String name)
Defines the name of the element.
|
void |
setOrphans(Integer orphans)
Defines the number of orphan-lines in this element.
|
void |
setOverflowX(Boolean overflowX)
Defines, whether text contained in this element will overflow horizontally.
|
void |
setOverflowY(Boolean overflowY)
Defines, whether text contained in this element will overflow vertically.
|
void |
setPadding(Float padding)
Defines the global padding of this box.
|
void |
setPaddingBottom(Float paddingBottom)
Defines the bottom padding of this box.
|
void |
setPaddingLeft(Float paddingLeft)
Defines the left padding of this box.
|
void |
setPaddingRight(Float paddingRight)
Defines the right padding of this box.
|
void |
setPaddingTop(Float paddingTop)
Defines the top padding of this box.
|
void |
setPreferredSize(Dimension2D preferredSize)
Returns the element's preferred size.
|
void |
setUseMinChunkWidth(Boolean useMinChunkWidth) |
void |
setVerticalAlignment(ElementAlignment verticalAlignment)
Defines the vertical alignment for the content of this element.
|
void |
setVisible(Boolean visible)
Defines, whether the element will be visible.
|
void |
setWidowOrphanOptOut(Boolean widowOrphanOptOut) |
void |
setWidows(Integer widows)
Defines the number of widow-lines in this element.
|
void |
setWidth(Float width)
Defines the elements preferred width.
|
void |
setX(Float x)
Defines the elements absolute horizontal position for the canvas-layout.
|
void |
setY(Float y)
Defines the elements absolute vertical position for the canvas-layout.
|
public Float getPadding()
public void setPadding(Float padding)
padding
- the padding or null, if the default should be used.public Float getBorderWidth()
public void setBorderWidth(Float borderWidth)
borderWidth
- the defined border width or null, if the default should be used.public BorderStyle getBorderStyle()
public void setBorderStyle(BorderStyle borderStyle)
borderStyle
- the defined border-style or null, if none is defined here.public Color getBorderColor()
public void setBorderColor(Color borderColor)
borderColor
- the defined color for all borders or null, if no global color is defined.public Dimension2D getBorderRadius()
public void setBorderRadius(Dimension2D borderRadius)
borderRadius
- the defined border-radius for all corners of this element or null, if no global default should be defined
here.public Float getBorderRadiusWidth()
public void setBorderRadiusWidth(Float borderRadiusWidth)
borderRadiusWidth
- the defined width of the border-radius for all corners of this element or null, if no global default
should be defined here.public Float getBorderRadiusHeight()
public void setBorderRadiusHeight(Float borderRadiusHeight)
borderRadiusHeight
- the defined height of the border-radius for all corners of this element or null, if no global default
should be defined here.public Dimension2D getBorderBottomLeftRadius()
public void setBorderBottomLeftRadius(Dimension2D borderRadius)
borderRadius
- the defined border-radius for the bottom-left corner of this element or null, if this property should be
undefined.public Float getBorderBottomLeftRadiusWidth()
public void setBorderBottomLeftRadiusWidth(Float borderBottomLeftRadiusWidth)
borderBottomLeftRadiusWidth
- the width of the defined border-radius for the bottom-left corner of this element or null, if this
property should be undefined.public Float getBorderBottomLeftRadiusHeight()
public void setBorderBottomLeftRadiusHeight(Float borderBottomLeftRadiusHeight)
borderBottomLeftRadiusHeight
- the height of the defined border-radius for the bottom-left corner of this element or null, if this
property should be undefined.public Dimension2D getBorderBottomRightRadius()
public void setBorderBottomRightRadius(Dimension2D borderRadius)
borderRadius
- the defined border-radius for the bottom-right corner of this element or null, if this property should be
undefined.public Float getBorderBottomRightRadiusWidth()
public void setBorderBottomRightRadiusWidth(Float borderBottomRightRadiusWidth)
borderBottomRightRadiusWidth
- the width of the defined border-radius for the bottom-right corner of this element or null, if this
property should be undefined.public Float getBorderBottomRightRadiusHeight()
public void setBorderBottomRightRadiusHeight(Float borderBottomRightRadiusHeight)
borderBottomRightRadiusHeight
- the height of the defined border-radius for the bottom-right corner of this element or null, if this
property should be undefined.public Dimension2D getBorderTopLeftRadius()
public void setBorderTopLeftRadius(Dimension2D borderRadius)
borderRadius
- the defined border-radius for the top-left corner of this element or null, if this property should be
undefined.public Float getBorderTopLeftRadiusWidth()
public void setBorderTopLeftRadiusWidth(Float borderTopLeftRadiusWidth)
borderTopLeftRadiusWidth
- the width of the defined border-radius for the top-left corner of this element or null, if this property
should be undefined.public Float getBorderTopLeftRadiusHeight()
public void setBorderTopLeftRadiusHeight(Float borderTopLeftRadiusHeight)
borderTopLeftRadiusHeight
- the height of the defined border-radius for the top-left corner of this element or null, if this property
should be undefined.public Dimension2D getBorderTopRightRadius()
public void setBorderTopRightRadius(Dimension2D borderRadius)
borderRadius
- the defined border-radius for the top-right corner of this element or null, if this property should be
undefined.public Float getBorderTopRightRadiusWidth()
public void setBorderTopRightRadiusWidth(Float borderTopRightRadiusWidth)
borderTopRightRadiusWidth
- the width of the defined border-radius for the top-right corner of this element or null, if this property
should be undefined.public Float getBorderTopRightRadiusHeight()
public void setBorderTopRightRadiusHeight(Float borderTopRightRadiusHeight)
borderTopRightRadiusHeight
- the height of the defined border-radius for the top-right corner of this element or null, if this property
should be undefined.public Color getColor()
public void setColor(Color color)
color
- the text color.public ElementAlignment getVerticalAlignment()
public void setVerticalAlignment(ElementAlignment verticalAlignment)
verticalAlignment
- the vertical alignment.public ElementAlignment getHorizontalAlignment()
public void setHorizontalAlignment(ElementAlignment horizontalAlignment)
horizontalAlignment
- the vertical alignment.public FontSmooth getFontSmooth()
public void setFontSmooth(FontSmooth fontSmooth)
fontSmooth
- the font-smooth constant or null, if this property should be left undefined.public Float getBorderTopWidth()
public void setBorderTopWidth(Float borderTopWidth)
borderTopWidth
- the border width for the top edge or null if the property should be left undefined.public Float getBorderLeftWidth()
public void setBorderLeftWidth(Float borderLeftWidth)
borderLeftWidth
- the border width for the left edge or null if the property should be left undefined.public Float getBorderBottomWidth()
public void setBorderBottomWidth(Float borderBottomWidth)
borderBottomWidth
- the border width for the bottom edge or null if the property should be left undefined.public Float getBorderRightWidth()
public void setBorderRightWidth(Float borderRightWidth)
borderRightWidth
- the border width for the right edge or null if the property should be left undefined.public Float getBorderBreakWidth()
public void setBorderBreakWidth(Float borderBreakWidth)
borderBreakWidth
- the width of the break edge of the border or null, if not defined.public BorderStyle getBorderTopStyle()
public void setBorderTopStyle(BorderStyle borderTopStyle)
borderTopStyle
- the border style for the top edge or null, if the style should remain undefined.public BorderStyle getBorderLeftStyle()
public void setBorderLeftStyle(BorderStyle borderLeftStyle)
borderLeftStyle
- the border style for the left edge or null, if the style should remain undefined.public BorderStyle getBorderBottomStyle()
public void setBorderBottomStyle(BorderStyle borderBottomStyle)
borderBottomStyle
- the border style for the bottom edge or null, if the style should remain undefined.public BorderStyle getBorderRightStyle()
public void setBorderRightStyle(BorderStyle borderRightStyle)
borderRightStyle
- the border style for the right edge or null, if the style should remain undefined.public BorderStyle getBorderBreakStyle()
public void setBorderBreakStyle(BorderStyle borderBreakStyle)
borderBreakStyle
- the border style for the break edge or null, if the style should remain undefined.public Color getBorderTopColor()
public void setBorderTopColor(Color borderTopColor)
borderTopColor
- the color for the top edge or null, if the value should be left undefined here.public Color getBorderLeftColor()
public void setBorderLeftColor(Color borderLeftColor)
borderLeftColor
- the color for the left edge or null, if the value should be left undefined here.public Color getBorderBottomColor()
public void setBorderBottomColor(Color borderBottomColor)
borderBottomColor
- the color for the bottom edge or null, if the value should be left undefined here.public Color getBorderRightColor()
public void setBorderRightColor(Color borderRightColor)
borderRightColor
- the color for the right edge or null, if the value should be left undefined here.public Color getBorderBreakColor()
public void setBorderBreakColor(Color borderBreakColor)
borderBreakColor
- the color for the break edge or null, if the value should be left undefined here.public Float getPaddingTop()
public void setPaddingTop(Float paddingTop)
paddingTop
- the padding or null, if the padding remains undefined here.public Float getPaddingLeft()
public void setPaddingLeft(Float paddingLeft)
paddingLeft
- the padding or null, if the padding remains undefined here.public Float getPaddingBottom()
public void setPaddingBottom(Float paddingBottom)
paddingBottom
- the padding or null, if the padding remains undefined here.public Float getPaddingRight()
public void setPaddingRight(Float paddingRight)
paddingRight
- the padding or null, if the padding remains undefined here.public Integer getWidows()
public void setWidows(Integer widows)
widows
- the number of widow-lines that control the pagebreak inside the paragraph.public Integer getOrphans()
public void setOrphans(Integer orphans)
orphans
- the number of orphan-lines that control the pagebreak inside the paragraph.public Boolean getWidowOrphanOptOut()
public void setWidowOrphanOptOut(Boolean widowOrphanOptOut)
public Color getBackgroundColor()
public void setBackgroundColor(Color backgroundColor)
backgroundColor
- the background color or null, if undefined.public Boolean getOverflowY()
public void setOverflowY(Boolean overflowY)
overflowY
- defines, whether text can overflow the box boundaries or null, to leave this property undefined.public Boolean getOverflowX()
public void setOverflowX(Boolean overflowX)
overflowX
- defines, whether text can overflow the box boundaries or null, to leave this property undefined.public Boolean getAvoidPagebreaks()
public void setAvoidPagebreaks(Boolean avoidPagebreaks)
avoidPagebreaks
- a boolean defining whether pagebreaks are allowed inside the box or null, if this property should be left
undefined.public String getHRefTarget()
public void setHRefTarget(String hRefTarget)
hRefTarget
- the link target.public String getName()
public void setName(String name)
name
- the element name.public Dimension2D getMinimumSize()
getMinimumWidth()
,
getMinimumHeight()
public void setMinimumSize(Dimension2D minimumSize)
minimumSize
- the element's minimum size.setMinimumWidth(Float)
,
setMinimumHeight(Float)
public Dimension2D getMaximumSize()
getMinimumWidth()
,
getMinimumHeight()
public void setMaximumSize(Dimension2D maximumSize)
maximumSize
- the element's maximum size.setMaximumWidth(Float)
,
setMaximumHeight(Float)
public Dimension2D getPreferredSize()
getWidth()
,
getHeight()
public void setPreferredSize(Dimension2D preferredSize)
preferredSize
- the element's preferred size.setWidth(Float)
,
setHeight(Float)
public Point2D getAbsolutePosition()
public void setAbsolutePosition(Point2D absolutePosition)
absolutePosition
- the element's absolute position.setX(Float)
,
setY(Float)
public Boolean getDynamicHeight()
public void setDynamicHeight(Boolean dynamicHeight)
dynamicHeight
- the new value of the elements dynamic height feature.public Boolean getLayoutCachable()
public void setLayoutCachable(Boolean layoutCachable)
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.layoutCachable
- the layout-cachable flag.public Boolean getVisible()
public void setVisible(Boolean visible)
visible
- the visibility flag of the element.public String getHRefWindow()
public void setHRefWindow(String hRefWindow)
hRefWindow
- the href-window string.public Float getMinimumWidth()
public void setMinimumWidth(Float minimumWidth)
minimumWidth
- the minimum width or null, to leave this property undefined.public Float getMinimumHeight()
public void setMinimumHeight(Float minimumHeight)
minimumHeight
- the minimum height or null, to leave this property undefined.public Float getMaximumWidth()
public void setMaximumWidth(Float maximumWidth)
maximumWidth
- the maximum width or null, if no maximum width should be defined.public Float getMaximumHeight()
public void setMaximumHeight(Float maximumHeight)
maximumHeight
- the maximum width or null, if no maximum height should be defined.public Float getWidth()
public void setWidth(Float width)
width
- the preferred width or null, if left undefined.public Float getHeight()
public void setHeight(Float height)
height
- the preferred height or null, if left undefined.public Float getX()
public void setX(Float x)
x
- the elements horizontal position or null, if not defined.public Float getY()
public void setY(Float y)
y
- the elements vertical position or null, if not defined.public String getHRefTitle()
public void setHRefTitle(String hRefTitle)
hRefTitle
- the href-title as string.public abstract Element createElement()
public void setUseMinChunkWidth(Boolean useMinChunkWidth)
public Boolean getUseMinChunkWidth()