org.pentaho.reporting.engine.classic.core.layout.model.context
Class StaticBoxLayoutProperties

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.layout.model.context.StaticBoxLayoutProperties
All Implemented Interfaces:
Serializable

public final class StaticBoxLayoutProperties
extends Object
implements Serializable

A static properties collection. That one is static; once computed it does not change anymore. It does not (under no thinkable circumstances) depend on the given content. It may depend on static content of the parent.

A box typically has two sets of margins. The first set is the declared margin set - it simply expresses the user's definitions. The second set is the effective margin set, it is based on the context of the element in the document tree and denotes the distance between the nodes edge and any oposite edge.

Author:
Thomas Morgner
See Also:
Serialized Form

Constructor Summary
StaticBoxLayoutProperties()
           
 
Method Summary
 long getBlockContextWidth()
          The block-context width is the computed width of the containing block of this element.
 long getBorderBottom()
           
 long getBorderLeft()
           
 long getBorderRight()
           
 long getBorderTop()
           
 long getComputedWidth()
           
 int getDominantBaseline()
           
 String getFontFamily()
           
 long getMarginBottom()
           
 long getMarginLeft()
           
 long getMarginRight()
           
 long getMarginTop()
           
 ExtendedBaselineInfo getNominalBaselineInfo()
           
 int getOrphans()
           
 long getSpaceWidth()
           
 int getWidows()
           
 boolean isAvoidPagebreakInside()
           
 boolean isBreakAfter()
           
 boolean isInvisibleConsumesSpace()
           
 boolean isOverflowX()
           
 boolean isOverflowY()
           
 boolean isPlaceholderBox()
           
 boolean isPreserveSpace()
           
 boolean isVisible()
           
 void setAvoidPagebreakInside(boolean avoidPagebreakInside)
           
 void setBlockContextWidth(long boxContextWidth)
          The block-context width is the computed width of the containing block of this element.
 void setBorderBottom(long borderBottom)
           
 void setBorderLeft(long borderLeft)
           
 void setBorderRight(long borderRight)
           
 void setBorderTop(long borderTop)
           
 void setBreakAfter(boolean breakAfter)
           
 void setComputedWidth(long computedWidth)
          Defines the computed width.
 void setDominantBaseline(int dominantBaseline)
           
 void setFontFamily(String fontFamily)
           
 void setInvisibleConsumesSpace(boolean invisibleConsumesSpace)
           
 void setMarginBottom(long marginBottom)
           
 void setMarginLeft(long marginLeft)
           
 void setMarginRight(long marginRight)
           
 void setMarginTop(long marginTop)
           
 void setNominalBaselineInfo(ExtendedBaselineInfo nominalBaselineInfo)
           
 void setOrphans(int orphans)
           
 void setOverflowX(boolean overflowX)
           
 void setOverflowY(boolean overflowY)
           
 void setPlaceholderBox(boolean placeholderBox)
           
 void setPreserveSpace(boolean preserveSpace)
           
 void setSpaceWidth(long spaceWidth)
           
 void setVisible(boolean visible)
           
 void setWidows(int widows)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StaticBoxLayoutProperties

public StaticBoxLayoutProperties()
Method Detail

getComputedWidth

public long getComputedWidth()

setComputedWidth

public void setComputedWidth(long computedWidth)
Defines the computed width. The computed-width is a static-property and is always specified as border-box size.

Parameters:
computedWidth -

getSpaceWidth

public long getSpaceWidth()

setSpaceWidth

public void setSpaceWidth(long spaceWidth)

getMarginLeft

public long getMarginLeft()

setMarginLeft

public void setMarginLeft(long marginLeft)

getMarginRight

public long getMarginRight()

setMarginRight

public void setMarginRight(long marginRight)

getMarginTop

public long getMarginTop()

setMarginTop

public void setMarginTop(long marginTop)

getMarginBottom

public long getMarginBottom()

setMarginBottom

public void setMarginBottom(long marginBottom)

getBorderLeft

public long getBorderLeft()

setBorderLeft

public void setBorderLeft(long borderLeft)

getBorderRight

public long getBorderRight()

setBorderRight

public void setBorderRight(long borderRight)

getBorderTop

public long getBorderTop()

setBorderTop

public void setBorderTop(long borderTop)

getBorderBottom

public long getBorderBottom()

setBorderBottom

public void setBorderBottom(long borderBottom)

getDominantBaseline

public int getDominantBaseline()

setDominantBaseline

public void setDominantBaseline(int dominantBaseline)

getNominalBaselineInfo

public ExtendedBaselineInfo getNominalBaselineInfo()

setNominalBaselineInfo

public void setNominalBaselineInfo(ExtendedBaselineInfo nominalBaselineInfo)

getFontFamily

public String getFontFamily()

setFontFamily

public void setFontFamily(String fontFamily)

getWidows

public int getWidows()

setWidows

public void setWidows(int widows)

getOrphans

public int getOrphans()

setOrphans

public void setOrphans(int orphans)

isAvoidPagebreakInside

public boolean isAvoidPagebreakInside()

setAvoidPagebreakInside

public void setAvoidPagebreakInside(boolean avoidPagebreakInside)

isPreserveSpace

public boolean isPreserveSpace()

setPreserveSpace

public void setPreserveSpace(boolean preserveSpace)

isBreakAfter

public boolean isBreakAfter()

setBreakAfter

public void setBreakAfter(boolean breakAfter)

getBlockContextWidth

public long getBlockContextWidth()
The block-context width is the computed width of the containing block of this element. Unlike the computed-width, this value is non-zero for elements contained in a inline- or row-context.

Returns:
the block-context width

setBlockContextWidth

public void setBlockContextWidth(long boxContextWidth)
The block-context width is the computed width of the containing block of this element. Unlike the computed-width, this value is non-zero for elements contained in a inline- or row-context.

Parameters:
boxContextWidth - the block-context width

isOverflowX

public boolean isOverflowX()

setOverflowX

public void setOverflowX(boolean overflowX)

isOverflowY

public boolean isOverflowY()

setOverflowY

public void setOverflowY(boolean overflowY)

isInvisibleConsumesSpace

public boolean isInvisibleConsumesSpace()

setInvisibleConsumesSpace

public void setInvisibleConsumesSpace(boolean invisibleConsumesSpace)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isPlaceholderBox

public boolean isPlaceholderBox()

setPlaceholderBox

public void setPlaceholderBox(boolean placeholderBox)

toString

public String toString()
Overrides:
toString in class Object