Class JRDesignFrame
java.lang.Object
net.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignFrame
- All Implemented Interfaces:
Serializable
,Cloneable
,JRChangeEventsSupport
,JRBoxContainer
,JRChild
,JRCloneable
,JRCommonElement
,JRElement
,JRElementGroup
,JRFrame
,JRIdentifiable
,JRPropertiesHolder
,JRStyleContainer
,JRVisitable
Implementation of
JRFrame
to be used at design time.- Author:
- Lucian Chirita (lucianc@users.sourceforge.net)
- See Also:
-
Field Summary
FieldsFields inherited from class net.sf.jasperreports.engine.design.JRDesignElement
PROPERTY_ELEMENT_GROUP, PROPERTY_HEIGHT, PROPERTY_KEY, PROPERTY_PARENT_STYLE, PROPERTY_PARENT_STYLE_NAME_REFERENCE, PROPERTY_PRINT_WHEN_EXPRESSION, PROPERTY_PRINT_WHEN_GROUP_CHANGES, PROPERTY_PROPERTY_EXPRESSIONS, PROPERTY_STYLE_EXPRESSION, PROPERTY_Y
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseElement
backcolor, defaultStyleProvider, elementGroup, forecolor, height, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, key, mode, parentStyle, parentStyleNameReference, positionType, printWhenExpression, printWhenGroupChanges, PROPERTY_POSITION_TYPE, PROPERTY_PRINT_IN_FIRST_WHOLE_BAND, PROPERTY_PRINT_REPEATED_VALUES, PROPERTY_PRINT_WHEN_DETAIL_OVERFLOWS, PROPERTY_REMOVE_LINE_WHEN_BLANK, PROPERTY_STRETCH_TYPE, PROPERTY_WIDTH, PROPERTY_X, stretchType, styleExpression, uuid, width, x, y
Fields inherited from interface net.sf.jasperreports.engine.JRElement
PROPERTY_ELEMENT_TEMPLATE_POPULATE_STYLE
Fields inherited from interface net.sf.jasperreports.engine.JRFrame
PROPERTY_FRAME_WIDTH_STRETCH_DISABLED
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new frame object.JRDesignFrame
(JRDefaultStyleProvider defaultStyleProvider) Creates a new frame object. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addElement
(int index, JRElement element) Inserts a sub element at specified position into the frame.void
addElement
(JRElement element) Adds a sub element to the frame.void
addElementGroup
(int index, JRElementGroup group) Inserts an element group at specified position into the frame.void
addElementGroup
(JRElementGroup group) Adds an element group to the frame.clone()
void
collectExpressions
(JRExpressionCollector collector) void
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 elementKey) 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.boolean
removeElement
(JRElement element) Removes a sub element from the frame.boolean
removeElementGroup
(JRElementGroup group) Removes a group element from the frame.void
setBorderSplitType
(BorderSplitType borderSplitType) Sets the border split type for the frame.void
Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleExpression, setStyleNameReference, setY
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseElement
clone, clone, getBackcolor, getBaseStyle, getDefaultStyleProvider, getElementGroup, getEventSupport, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getParentProperties, getPositionType, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertiesMap, getStretchType, getStyle, getStyleExpression, getStyleNameReference, getStyleResolver, getUUID, getWidth, getX, getY, hasProperties, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setBackcolor, setForecolor, setMode, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setUUID, setWidth, setX
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement
getBackcolor, getForecolor, getHeight, getKey, getOwnBackcolor, getOwnForecolor, getOwnMode, getWidth, setBackcolor, setForecolor, setMode
Methods 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, setX
Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup
getElementGroup
Methods inherited from interface net.sf.jasperreports.engine.JRIdentifiable
getUUID
Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder
getParentProperties, getPropertiesMap, hasProperties
Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer
getDefaultStyleProvider, getStyle, getStyleName, getStyleNameReference
-
Field Details
-
PROPERTY_CHILDREN
- See Also:
-
PROPERTY_BORDER_SPLIT_TYPE
- See Also:
-
-
Constructor Details
-
JRDesignFrame
Creates a new frame object.- Parameters:
defaultStyleProvider
- default style provider instance
-
JRDesignFrame
public JRDesignFrame()Creates a new frame object.
-
-
Method Details
-
collectExpressions
- Specified by:
collectExpressions
in interfaceJRElement
-
visit
- Specified by:
visit
in interfaceJRVisitable
-
getElements
Description copied from interface:JRElementGroup
Gets an array containing all the elements and element groups in the hierarchy.- Specified by:
getElements
in interfaceJRElementGroup
-
addElement
Adds a sub element to the frame.- Parameters:
element
- the element to add
-
addElement
Inserts a sub element at specified position into the frame.- Parameters:
index
- the element positionelement
- the element to add
-
removeElement
Removes a sub element from the frame.- Parameters:
element
- the element to remove- Returns:
- true if this frame contained the specified element
-
addElementGroup
Adds an element group to the frame.- Parameters:
group
- the element group to add
-
addElementGroup
Inserts an element group at specified position into the frame.- Parameters:
index
- the element group positiongroup
- the element group to add
-
removeElementGroup
Removes a group element from the frame.- Parameters:
group
- the group to remove- Returns:
- true if this frame contained the specified group
-
getChildren
Description copied from interface:JRElementGroup
Gets a list of all direct children elements or elements groups.- Specified by:
getChildren
in interfaceJRElementGroup
-
getElementByKey
Description copied from interface:JRElementGroup
Gets an element from this group, based on its element key.- Specified by:
getElementByKey
in interfaceJRElementGroup
-
getMode
Description copied from interface:JRCommonElement
Returns 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:
getMode
in interfaceJRCommonElement
- Overrides:
getMode
in classJRBaseElement
-
getLineBox
- Specified by:
getLineBox
in interfaceJRBoxContainer
-
copyBox
-
getDefaultLineColor
- Specified by:
getDefaultLineColor
in interfaceJRBoxContainer
-
getBorderSplitType
Description copied from interface:JRFrame
Determines how should the frames borders behave when the frame splits on two pages.- Specified by:
getBorderSplitType
in interfaceJRFrame
- Returns:
- the border split type
- See Also:
-
setBorderSplitType
Sets the border split type for the frame.- Parameters:
borderSplitType
- the border split type- See Also:
-
clone
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classJRDesignElement
-