Package org.pentaho.reporting.engine.classic.core.layout.model

Class BreakMarkerRenderBox

java.lang.Object

org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

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

org.pentaho.reporting.engine.classic.core.layout.model.BlockRenderBox

org.pentaho.reporting.engine.classic.core.layout.model.BreakMarkerRenderBox

All Implemented Interfaces:

Cloneable

public final class BreakMarkerRenderBox
extends BlockRenderBox

A special box that simply marks the position of an automatic pagebreak. This is needed in the process of the event ordering and rollback processing.

Author:

Thomas Morgner

Nested Class Summary

Nested classes/interfaces inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderBox

RenderBox.BreakIndicator, RenderBox.RestrictFinishClearOut

Nested classes/interfaces inherited from class org.pentaho.reporting.engine.classic.core.layout.model.RenderNode

RenderNode.CacheState

Field Summary

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

FLAG_BOX_CONTAINS_PRESERVED_CONTENT, FLAG_BOX_INVALID_WIDOW_ORPHAN_NODE, FLAG_BOX_TABLE_SECTION_RESERVED, FLAG_BOX_TABLE_SECTION_RESERVED2, FLAG_BOX_TABLE_SECTION_RESERVED3, FLAG_BOX_TABLE_SECTION_RESERVED4, FLAG_BOX_TABLE_SECTION_RESERVED5

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

CACHE_CLEAN, CACHE_DEEP_DIRTY, CACHE_DIRTY, HORIZONTAL_AXIS, VERTICAL_AXIS

Constructor Summary

Constructors

Constructor	Description
BreakMarkerRenderBox(StyleSheet styleSheet, InstanceID instanceID, BoxDefinition boxDefinition, ElementType elementType, ReportAttributeMap attributeMap, ReportStateKey stateKey, long validityRange)

Method Summary

Modifier and Type	Method	Description
int	getNodeType()
long	getValidityRange()	The page-offset of the page where this break-marker is valid.
boolean	isIgnorableForRendering()	If that method returns true, the element will not be used for rendering.

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

isBlockForPagebreakPurpose

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

addChild, addChilds, addGeneratedChild, addGeneratedChilds, addOverflowArea, apply, clear, close, commit, create, decreaseContentReferenceCount, decreaseDescendantCount, decreaseTableReferenceCount, derive, deriveFrozen, extendHeight, extendHeightInBlockMode, extendHeightInRowMode, findNodeById, freeze, getAppliedContentRefCount, getBaselineInfo, getBoxDefinition, getChildCount, getContentAge, getContentAreaX1, getContentAreaX2, getContentBox, getContentRefCount, getDescendantCount, getEffectiveMinimumChunkSize, getFirstChild, getInsets, getInsetsLeft, getInsetsRight, getLastChild, getManualBreakIndicator, getName, getOrphanConstraintSize, getOrphanLeafCount, getOverflowAreaHeight, getOverflowAreaWidth, getParentWidowContexts, getPinned, getProcessKeyCached, getProcessKeyStepAge, getRawValue, getRestrictFinishedClearOut, getStateKey, getStaticBoxLayoutProperties, getStaticBoxPropertiesAge, getTableExportState, getTableRefCount, getTableValidationAge, getTextEllipseBox, getVerticalInsets, getWidowConstraintSize, getWidowConstraintSizeWithKeepTogether, getWidowLeafCount, increaseContentReferenceCount, increaseDescendantCount, increaseTableReferenceCount, isAcceptInlineBoxes, isAppendable, isAppliedOpen, isAppliedSeen, isBoxOverflowX, isBoxOverflowY, isBreakAfter, isCommited, isContainsReservedContent, isContentRefHolder, isDeepFinishedTable, isDiscardable, isEmpty, isEmptyNodesHaveSignificance, isInvalidWidowOrphanNode, isMarkedOpen, isMarkedSeen, isOpen, isOrphanLeaf, isPinned, isPreventPagination, isProcessKeyCacheValid, isProcessKeyFinish, isRenderBox, isSizeSpecifiesBorderBox, markAsContentRefHolder, markBoxSeen, markPinned, remove, replaceChild, replaceChilds, resetCacheState, rollback, setBaselineInfo, setContainsReservedContent, setContentAge, setContentAreaX1, setContentAreaX2, setContentBox, setDeepFinished, setFirstChild, setInvalidWidowOrphanNode, setLastChild, setManualBreakIndicator, setMinimumChunkWidth, setName, setOpen, setOrphanConstraintSize, setOrphanLeafCount, setOverflowAreaHeight, setOverflowAreaWidth, setParentWidowContexts, setPreventPagination, setProcessKeyCached, setRawValue, setRestrictFinishedClearOut, setStateKey, setStaticBoxPropertiesAge, setTableExportState, setTableValidationAge, setTextEllipseBox, setWidowConstraintSize, setWidowConstraintSizeWithKeepTogether, setWidowLeafCount, split, toString, updateChangeTracker, useMinimumChunkWidth

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

clone, getApplyState, getAttributes, getCachedAge, getCachedHeight, getCachedWidth, getCachedX, getCachedX2, getCachedY, getCachedY2, getCacheState, getChangeTracker, getEffectiveMarginBottom, getEffectiveMarginTop, getElementType, getHeight, getInstanceId, getLayoutNodeType, getLayoutParent, getLinebreakAge, getLogicalPage, getMajorAxis, getMaximumBoxWidth, getMinimumChunkWidth, getMinorAxis, getNext, getNodeLayoutProperties, getParent, getPrev, getRowIndex, getStyleSheet, getValidateModelAge, getVerticalTextAlignment, getWidth, getX, getY, getY2, isBoxVisible, isBoxVisible, isCacheValid, isFinishedPaginate, isFinishedTable, isFlag, isFrozen, isLinebreakCacheValid, isNodeVisible, isNodeVisible, isNodeVisible, isNodeVisible, isParanoidModelChecks, isValidateModelCacheValid, isValidateModelResult, isVirtualNode, isVisible, isWidowBox, markApplyStateDirty, reinit, resetValidateModelResult, setCachedAge, setCachedHeight, setCachedWidth, setCachedX, setCachedY, setFinishedPaginate, setFinishedTable, setFlag, setHeight, setLinebreakAge, setMaximumBoxWidth, setNext, setNextUnchecked, setParent, setPrev, setPrevUnchecked, setValidateModelResult, setVirtualNode, setWidowBox, setWidth, setX, setY, shift, shiftCached, updateCacheState

Methods inherited from class java.lang.Object

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

Constructor Detail

BreakMarkerRenderBox

public BreakMarkerRenderBox(StyleSheet styleSheet,
                            InstanceID instanceID,
                            BoxDefinition boxDefinition,
                            ElementType elementType,
                            ReportAttributeMap attributeMap,
                            ReportStateKey stateKey,
                            long validityRange)

Method Detail

getValidityRange

public long getValidityRange()

The page-offset of the page where this break-marker is valid. Note that the page-offset denotes the start of the page, not the end.

Returns:

the validity of this break marker.

isIgnorableForRendering

public boolean isIgnorableForRendering()

Description copied from class: RenderNode

If that method returns true, the element will not be used for rendering. For the purpose of computing sizes or performing the layouting (in the validate() step), this element will treated as if it is not there.

If the element reports itself as non-empty, however, it will affect the margin computation.

Overrides:

isIgnorableForRendering in class RenderNode

Returns:

getNodeType

public int getNodeType()

Overrides:

getNodeType in class BlockRenderBox