Package net.sf.jasperreports.engine.fill
Class JRFillFrame
java.lang.Object
net.sf.jasperreports.engine.fill.JRFillElement
net.sf.jasperreports.engine.fill.JRFillFrame
- All Implemented Interfaces:
Cloneable,DynamicPropertiesHolder,JRFillCloneable,JRBoxContainer,JRChild,JRCloneable,JRCommonElement,JRElement,JRElementGroup,JRFrame,JRIdentifiable,JRPropertiesHolder,JRStyleContainer,JRStyleSetter,JRVisitable
Fill time implementation of a frame element.
- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classFrame element container filler. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final BorderSplitTypeprotected final JRLineBoxprotected final JRFrameprotected final booleanFields inherited from class net.sf.jasperreports.engine.fill.JRFillElement
band, conditionalStylesContainer, currentEvaluation, currentStyle, defaultPopulateTemplateStyle, defaultStyleProvider, delayedEvaluationsMap, dynamicProperties, dynamicTransferProperties, elementGroup, EXCEPTION_MESSAGE_KEY_INVALID_BOOKMARK_LEVEL, expressionEvaluator, exprStyle, fillContainerContext, filler, hasDynamicPopulateTemplateStyle, initStyle, mergedProperties, originProvider, parent, printElementOriginator, printWhenGroupChanges, propertyExpressions, providerStyle, staticProperties, staticTransferProperties, styleProviders, templatesFields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLEFields inherited from interface net.sf.jasperreports.engine.JRFrame
PROPERTY_BORDER_SPLIT_TYPE, PROPERTY_FRAME_WIDTH_STRETCH_DISABLED -
Constructor Summary
ConstructorsModifierConstructorDescriptionJRFillFrame(JRBaseFiller filler, JRFrame frame, JRFillObjectFactory factory) protectedJRFillFrame(JRFillFrame frame, JRFillCloneFactory factory) -
Method Summary
Modifier and TypeMethodDescriptionvoidcollectExpressions(JRExpressionCollector collector) createClone(JRFillCloneFactory factory) Creates a working clone of itself.protected JRTemplateElementprotected JRTemplateFrameprotected booleanprotected booleanprotected voidevaluate(byte evaluation) protected voidevaluateStyle(byte evaluation) protected JRPrintElementfill()Determines how should the frames borders behave when the frame splits on two pages.Gets a list of all direct children elements or elements groups.getElementByKey(String key) Gets an element from this group, based on its element key.Gets an array containing all the elements and element groups in the hierarchy.getMode()Returns the element transparency mode.protected JRTemplateFrameprotected booleanprepare(int availableHeight, boolean isOverflow, boolean isOverflowAllowed) protected voidresolveElement(JRPrintElement element, byte evaluation) Resolves an element.protected voidrewind()protected voidsetStretchHeight(int stretchHeight) protected booleanstretchElementToHeight(int stretchHeight) This method returns a boolean signaling if any stretch change occurred.voidMethods inherited from class net.sf.jasperreports.engine.fill.JRFillElement
addDependantElement, addDynamicProperty, clone, clone, clone, collectDelayedEvaluations, collectDelayedEvaluations, collectDelayedEvaluations, collectStyleDelayedEvaluations, collectStyleProviderDelayedEvaluations, delayedEvaluate, delayedEvaluationUpdatesTemplate, evaluateExpression, evaluatePrintWhenExpression, evaluateProperties, getBackcolor, getBand, getBookmarkLevel, getCollapsedHeightAbove, getCollapsedHeightBelow, getConditionalStylesContainer, getDefaultStyleProvider, getDependantElements, getDynamicProperties, getElementGroup, getElementOrigin, getElementTemplate, getEvaluatedProperties, getEvaluationTime, getField, getFiller, getForecolor, getGroupElements, getHeight, getInitStyle, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParent, getParentProperties, getPositionType, getPrepareHeight, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getPropertyExpressions, getRelativeY, getStretchHeight, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getTemplate, getTimeZone, getUUID, getVariable, getWidth, getX, getY, hasDynamicProperties, hasDynamicProperty, hasProperties, initDelayedEvaluationPrint, initDelayedEvaluations, initStyleProviders, isAlreadyPrinted, isAutoEvaluateNow, isDelayedStyleEvaluation, isEvaluateAuto, isEvaluateNow, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isPrintWhenExpressionNull, isPrintWhenTrue, isRemoveLineWhenBlank, isReprinted, isToPrint, isValueRepeating, moveDependantElements, performDelayedEvaluation, registerTemplate, reset, resolveElement, setAlreadyPrinted, setBackcolor, setBand, setCollapsedHeightAbove, setCollapsedHeightBelow, setConditionalStylesContainer, setCurrentEvaluation, setExpressionEvaluator, setForecolor, setHeight, setMode, setOriginProvider, setPositionType, setPrepareHeight, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setPrintWhenExpressionNull, setPrintWhenTrue, setRelativeY, setRemoveLineWhenBlank, setReprinted, setShrinkable, setStretchType, setStyle, setStyleNameReference, setToPrint, setValueRepeating, setWidth, setX, setY, stretchElement, stretchElementToContainer, stretchElementToElementGroup, toPopulateTemplateStyle, transferProperties, transferPropertiesMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface net.sf.jasperreports.engine.JRCloneable
cloneMethods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setModeMethods inherited from interface net.sf.jasperreports.engine.JRElement
clone, getElementGroup, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStyleExpression, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setWidth, setXMethods inherited from interface net.sf.jasperreports.engine.JRElementGroup
getElementGroupMethods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUIDMethods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasPropertiesMethods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
Field Details
-
parentFrame
-
lineBox
-
borderSplitType
-
widthStretchEnabled
protected final boolean widthStretchEnabled
-
-
Constructor Details
-
JRFillFrame
-
JRFillFrame
-
-
Method Details
-
getMode
Description copied from interface:JRCommonElementReturns the element transparency mode. The default value depends on the type of the report element. Graphic elements like rectangles and lines are opaque by default, but the images are transparent. Both static texts and text fields are transparent by default, and so are the subreport elements.- Specified by:
getModein interfaceJRCommonElement- Overrides:
getModein classJRFillElement
-
getDefaultLineColor
- Specified by:
getDefaultLineColorin interfaceJRBoxContainer
-
evaluate
- Specified by:
evaluatein classJRFillElement- Throws:
JRException
-
evaluateStyle
- Overrides:
evaluateStylein classJRFillElement- Throws:
JRException
-
rewind
- Specified by:
rewindin classJRFillElement- Throws:
JRException
-
drawTopBorderOnSplit
protected boolean drawTopBorderOnSplit() -
drawBotomBorderOnSplit
protected boolean drawBotomBorderOnSplit() -
prepare
protected boolean prepare(int availableHeight, boolean isOverflow, boolean isOverflowAllowed) throws JRException - Overrides:
preparein classJRFillElement- Throws:
JRException
-
setStretchHeight
protected void setStretchHeight(int stretchHeight) - Overrides:
setStretchHeightin classJRFillElement
-
stretchElementToHeight
protected boolean stretchElementToHeight(int stretchHeight) Description copied from class:JRFillElementThis method returns a boolean signaling if any stretch change occurred. It does not say which amount of stretch was applied, but that is OK, because the only place where this is checked is during frame cascading stretch, where the stretchHeight field of the frame (set here) is used directly.- Overrides:
stretchElementToHeightin classJRFillElement
-
fill
- Specified by:
fillin classJRFillElement- Throws:
JRException
-
getTemplate
-
createFrameTemplate
-
createElementTemplate
- Specified by:
createElementTemplatein classJRFillElement
-
resolveElement
Description copied from class:JRFillElementResolves an element.- Specified by:
resolveElementin classJRFillElement- Parameters:
element- the elementevaluation- the evaluation type
-
getElements
Description copied from interface:JRElementGroupGets an array containing all the elements and element groups in the hierarchy.- Specified by:
getElementsin interfaceJRElementGroup
-
getChildren
Description copied from interface:JRElementGroupGets a list of all direct children elements or elements groups.- Specified by:
getChildrenin interfaceJRElementGroup
-
collectExpressions
- Specified by:
collectExpressionsin interfaceJRElement
-
getLineBox
- Specified by:
getLineBoxin interfaceJRBoxContainer
-
getBorderSplitType
Description copied from interface:JRFrameDetermines how should the frames borders behave when the frame splits on two pages.- Specified by:
getBorderSplitTypein interfaceJRFrame- Returns:
- the border split type
- See Also:
-
visit
- Specified by:
visitin interfaceJRVisitable
-
getElementByKey
Description copied from interface:JRElementGroupGets an element from this group, based on its element key.- Specified by:
getElementByKeyin interfaceJRElementGroup
-
createClone
Description copied from interface:JRFillCloneableCreates a working clone of itself.- Specified by:
createClonein interfaceJRFillCloneable- Parameters:
factory- the clone factory to use while creating the clone- Returns:
- a working clone of itself
-