org.pentaho.reporting.engine.classic.core.layout.model
Class RenderBox

java.lang.Object
  org.pentaho.reporting.engine.classic.core.layout.model.RenderNode
      org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

BlockRenderBox, CanvasRenderBox, InlineRenderBox, RenderableReplacedContentBox, RowRenderBox

public abstract class RenderBox
extends RenderNode

Creation-Date: 03.04.2007, 13:17:47

Author:

Thomas Morgner

Field Summary

static int	DIRECT_MANUAL_BREAK
static int	INDIRECT_MANUAL_BREAK
static int	NO_MANUAL_BREAK

Fields inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

CACHE_CLEAN, CACHE_DEEP_DIRTY, CACHE_DIRTY, HORIZONTAL_AXIS, VERTICAL_AXIS

Method Summary

void	addChild(RenderNode child)
void	addChilds(RenderNode[] nodes)
void	addGeneratedChild(RenderNode child)
void	addGeneratedChilds(RenderNode[] nodes)
void	clear() Removes all children.
void	close()
void	commitApplyMark()
RenderNode	derive(boolean deepDerive) Derive creates a disconnected node that shares all the properties of the original node.
RenderNode	deriveFrozen(boolean deepDerive) Derive creates a disconnected node that shares all the properties of the original node.
RenderNode	findNodeById(Object instanceId)
void	freeze()
int	getAppliedContentRefCount()
ExtendedBaselineInfo	getBaselineInfo()
BoxDefinition	getBoxDefinition()
Object	getBreakContext()
long	getComputedWidth()
long	getContentAge()
long	getContentAreaX1()
long	getContentAreaX2()
Boolean	getContentBox()
int	getContentRefCount() The content-ref-count counts inline-subreports.
RenderNode	getFirstChild()
long	getInsets()
RenderNode	getLastChild()
int	getManualBreakIndicator()
String	getName()
long	getPinned()
ReportStateKey	getStateKey()
StaticBoxLayoutProperties	getStaticBoxLayoutProperties()
long	getStaticBoxPropertiesAge()
Object	getTableExportState()
RenderBox	getTextEllipseBox()
RenderNode	hibernate() Derive creates a disconnected node that shares all the properties of the original node.
boolean	isAppendable()
boolean	isAppliedOpen()
boolean	isAppliedSeen()
boolean	isAutoGenerated()
boolean	isBoxOverflowX()
boolean	isBoxOverflowY()
boolean	isBreakAfter()
boolean	isCommited()
boolean	isDeepFinished()
boolean	isDiscardable()
boolean	isEmpty()
boolean	isMarkedOpen()
boolean	isMarkedSeen()
boolean	isOpen()
boolean	isPinned()
boolean	isSizeSpecifiesBorderBox()
void	markBoxSeen()
void	markCacheClean()
void	markPinned(long pinPosition)
void	remove(RenderNode child)
void	removeGenerated(RenderNode child)
void	reopenAfterRollback(boolean deepDirty)
void	replaceChild(RenderNode old, RenderNode replacement)
void	replaceChilds(RenderNode old, RenderNode[] replacement)
void	resetCacheState(boolean deepDirty)
void	setAutoGenerated(boolean autoGenerated)
void	setBaselineInfo(ExtendedBaselineInfo baselineInfo)
void	setBreakContext(Object breakContext)
void	setComputedWidth(long computedWidth)
void	setContentAge(long contentAge)
void	setContentAreaX1(long contentAreaX1)
void	setContentAreaX2(long contentAreaX2)
void	setContentBox(Boolean contentBox)
void	setDeepFinished(boolean deepFinished)
void	setManualBreakIndicator(int manualBreakIndicator)
void	setMinimumChunkWidth(long minimumChunkWidth)
void	setName(String name)
void	setStaticBoxPropertiesAge(long staticBoxPropertiesAge)
void	setTableExportState(Object tableExportState)
void	setTextEllipseBox(RenderBox textEllipseBox)
RenderBox	split(int axis) Performs a simple split.
String	toString()

Methods inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

apply, clone, getAttributes, getCachedAge, getCachedHeight, getCachedParentWidth, getCachedWidth, getCachedX, getCachedY, getCacheState, getChangeTracker, getEffectiveMarginBottom, getEffectiveMarginTop, getElementType, getHeight, getInstanceId, getLogicalPage, getMajorAxis, getMaximumBoxWidth, getMinimumChunkWidth, getMinorAxis, getNext, getNodeLayoutProperties, getNodeType, getParent, getPrev, getStyleSheet, getVerticalTextAlignment, getWidth, getX, getY, isBoxVisible, isBoxVisible, isCacheValid, isFinishedPaginate, isFinishedTable, isFrozen, isHibernated, isIgnorableForRendering, isNodeVisible, isNodeVisible, isNodeVisible, isNodeVisible, isVirtualNode, setCachedAge, setCachedHeight, setCachedParentWidth, setCachedWidth, setCachedX, setCachedY, setFinishedPaginate, setFinishedTable, setHeight, setMaximumBoxWidth, setVirtualNode, setWidth, setX, setY, shift, shiftCached

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_MANUAL_BREAK

public static final int NO_MANUAL_BREAK

See Also:

Constant Field Values

DIRECT_MANUAL_BREAK

public static final int DIRECT_MANUAL_BREAK

See Also:

Constant Field Values

INDIRECT_MANUAL_BREAK

public static final int INDIRECT_MANUAL_BREAK

See Also:

Constant Field Values

Method Detail

isAutoGenerated

public boolean isAutoGenerated()

setAutoGenerated

public void setAutoGenerated(boolean autoGenerated)

isSizeSpecifiesBorderBox

public boolean isSizeSpecifiesBorderBox()

Overrides:

isSizeSpecifiesBorderBox in class RenderNode

getTextEllipseBox

public RenderBox getTextEllipseBox()

setTextEllipseBox

public void setTextEllipseBox(RenderBox textEllipseBox)

getStateKey

public ReportStateKey getStateKey()

Overrides:

getStateKey in class RenderNode

getManualBreakIndicator

public int getManualBreakIndicator()

setManualBreakIndicator

public void setManualBreakIndicator(int manualBreakIndicator)

getBoxDefinition

public BoxDefinition getBoxDefinition()

getInsets

public long getInsets()

getFirstChild

public RenderNode getFirstChild()

getLastChild

public RenderNode getLastChild()

addGeneratedChild

public void addGeneratedChild(RenderNode child)

addChild

public void addChild(RenderNode child)

getContentRefCount

public int getContentRefCount()

The content-ref-count counts inline-subreports.

Overrides:

getContentRefCount in class RenderNode

replaceChild

public void replaceChild(RenderNode old,
                         RenderNode replacement)

replaceChilds

public void replaceChilds(RenderNode old,
                          RenderNode[] replacement)

derive

public RenderNode derive(boolean deepDerive)

Derive creates a disconnected node that shares all the properties of the original node. The derived node will no longer have any parent, silbling, child or any other relationships with other nodes.

Overrides:

derive in class RenderNode

Returns:

hibernate

public RenderNode hibernate()

Derive creates a disconnected node that shares all the properties of the original node. The derived node will no longer have any parent, silbling, child or any other relationships with other nodes.

Overrides:

hibernate in class RenderNode

Returns:

deriveFrozen

public RenderNode deriveFrozen(boolean deepDerive)

Derive creates a disconnected node that shares all the properties of the original node. The derived node will no longer have any parent, silbling, child or any other relationships with other nodes.

Overrides:

deriveFrozen in class RenderNode

Returns:

addChilds

public void addChilds(RenderNode[] nodes)

addGeneratedChilds

public void addGeneratedChilds(RenderNode[] nodes)

findNodeById

public RenderNode findNodeById(Object instanceId)

Overrides:

findNodeById in class RenderNode

isAppendable

public boolean isAppendable()

clear

public void clear()

Removes all children.

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class RenderNode

isDiscardable

public boolean isDiscardable()

Overrides:

isDiscardable in class RenderNode

close

public void close()

remove

public void remove(RenderNode child)

removeGenerated

public void removeGenerated(RenderNode child)

isOpen

public boolean isOpen()

Overrides:

isOpen in class RenderNode

freeze

public void freeze()

Overrides:

freeze in class RenderNode

split

public RenderBox split(int axis)

Performs a simple split. This box will be altered to form the left/top side of the split, and a derived empty box will be returned, which makes up the right/bottom side.

A split will only happen on inline-boxes during the line-break-step. In the ordinary layouting, splitting is not necesary.

Parameters:

axis -

Returns:

getContentAreaX1

public long getContentAreaX1()

setContentAreaX1

public void setContentAreaX1(long contentAreaX1)

getContentAreaX2

public long getContentAreaX2()

setContentAreaX2

public void setContentAreaX2(long contentAreaX2)

getStaticBoxLayoutProperties

public StaticBoxLayoutProperties getStaticBoxLayoutProperties()

getBaselineInfo

public ExtendedBaselineInfo getBaselineInfo()

setBaselineInfo

public void setBaselineInfo(ExtendedBaselineInfo baselineInfo)

getName

public String getName()

Overrides:

getName in class RenderNode

setName

public void setName(String name)

isBreakAfter

public boolean isBreakAfter()

Overrides:

isBreakAfter in class RenderNode

getStaticBoxPropertiesAge

public long getStaticBoxPropertiesAge()

setStaticBoxPropertiesAge

public void setStaticBoxPropertiesAge(long staticBoxPropertiesAge)

toString

public String toString()

Overrides:

toString in class Object

markCacheClean

public void markCacheClean()

Overrides:

markCacheClean in class RenderNode

commitApplyMark

public void commitApplyMark()

getAppliedContentRefCount

public int getAppliedContentRefCount()

isAppliedOpen

public boolean isAppliedOpen()

isAppliedSeen

public boolean isAppliedSeen()

isMarkedOpen

public boolean isMarkedOpen()

isMarkedSeen

public boolean isMarkedSeen()

markBoxSeen

public void markBoxSeen()

isCommited

public boolean isCommited()

reopenAfterRollback

public void reopenAfterRollback(boolean deepDirty)

resetCacheState

public void resetCacheState(boolean deepDirty)

getComputedWidth

public long getComputedWidth()

Overrides:

getComputedWidth in class RenderNode

setComputedWidth

public void setComputedWidth(long computedWidth)

isDeepFinished

public boolean isDeepFinished()

setDeepFinished

public void setDeepFinished(boolean deepFinished)

setContentAge

public void setContentAge(long contentAge)

getContentAge

public long getContentAge()

getContentBox

public Boolean getContentBox()

setContentBox

public void setContentBox(Boolean contentBox)

getTableExportState

public Object getTableExportState()

setTableExportState

public void setTableExportState(Object tableExportState)

markPinned

public void markPinned(long pinPosition)

isPinned

public boolean isPinned()

getPinned

public long getPinned()

setMinimumChunkWidth

public void setMinimumChunkWidth(long minimumChunkWidth)

isBoxOverflowX

public boolean isBoxOverflowX()

Overrides:

isBoxOverflowX in class RenderNode

isBoxOverflowY

public boolean isBoxOverflowY()

Overrides:

isBoxOverflowY in class RenderNode

getBreakContext

public Object getBreakContext()

setBreakContext

public void setBreakContext(Object breakContext)