|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseElement
net.sf.jasperreports.engine.design.JRDesignElement
net.sf.jasperreports.engine.design.JRDesignFrame
public class JRDesignFrame
Implementation of JRFrame to be used at design time.
| Field Summary | |
|---|---|
static java.lang.String |
PROPERTY_CHILDREN
|
| Fields 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_Y |
| Fields inherited from interface net.sf.jasperreports.engine.JRElement |
|---|
MODE_OPAQUE, MODE_TRANSPARENT, POSITION_TYPE_FIX_RELATIVE_TO_BOTTOM, POSITION_TYPE_FIX_RELATIVE_TO_TOP, POSITION_TYPE_FLOAT, STRETCH_TYPE_NO_STRETCH, STRETCH_TYPE_RELATIVE_TO_BAND_HEIGHT, STRETCH_TYPE_RELATIVE_TO_TALLEST_OBJECT |
| Constructor Summary | |
|---|---|
JRDesignFrame()
Creates a new frame object. |
|
JRDesignFrame(JRDefaultStyleProvider defaultStyleProvider)
Creates a new frame object. |
|
| Method Summary | |
|---|---|
void |
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. |
java.lang.Object |
clone()
|
void |
collectExpressions(JRExpressionCollector collector)
|
void |
copyBox(JRLineBox lineBox)
|
byte |
getBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getBorderColor()
Deprecated. Replaced by getBox() |
byte |
getBottomBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getBottomBorderColor()
Deprecated. Replaced by getBox() |
int |
getBottomPadding()
Deprecated. Replaced by getBox() |
JRBox |
getBox()
Deprecated. Replaced by getLineBox() |
java.util.List |
getChildren()
Gets a list of all direct children elements or elements groups. |
java.awt.Color |
getDefaultLineColor()
|
JRElement |
getElementByKey(java.lang.String elementKey)
Gets an element from this group, based on its element key. |
JRElement[] |
getElements()
Gets an array containing all the elements and element groups in the hierarchy. |
byte |
getLeftBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getLeftBorderColor()
Deprecated. Replaced by getBox() |
int |
getLeftPadding()
Deprecated. Replaced by getBox() |
JRLineBox |
getLineBox()
|
ModeEnum |
getModeValue()
Returns the element transparency mode. |
java.lang.Byte |
getOwnBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getOwnBorderColor()
Deprecated. Replaced by getBox() |
java.lang.Byte |
getOwnBottomBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getOwnBottomBorderColor()
Deprecated. Replaced by getBox() |
java.lang.Integer |
getOwnBottomPadding()
Deprecated. Replaced by getBox() |
java.lang.Byte |
getOwnLeftBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getOwnLeftBorderColor()
Deprecated. Replaced by getBox() |
java.lang.Integer |
getOwnLeftPadding()
Deprecated. Replaced by getBox() |
java.lang.Integer |
getOwnPadding()
Deprecated. Replaced by getBox() |
java.lang.Byte |
getOwnRightBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getOwnRightBorderColor()
Deprecated. Replaced by getBox() |
java.lang.Integer |
getOwnRightPadding()
Deprecated. Replaced by getBox() |
java.lang.Byte |
getOwnTopBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getOwnTopBorderColor()
Deprecated. Replaced by getBox() |
java.lang.Integer |
getOwnTopPadding()
Deprecated. Replaced by getBox() |
int |
getPadding()
Deprecated. Replaced by getBox() |
byte |
getRightBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getRightBorderColor()
Deprecated. Replaced by getBox() |
int |
getRightPadding()
Deprecated. Replaced by getBox() |
byte |
getTopBorder()
Deprecated. Replaced by getBox() |
java.awt.Color |
getTopBorderColor()
Deprecated. Replaced by getBox() |
int |
getTopPadding()
Deprecated. Replaced by getBox() |
boolean |
removeElement(JRElement element)
Removes a sub element from the frame. |
boolean |
removeElementGroup(JRElementGroup group)
Removes a group element from the frame. |
void |
setBorder(byte border)
Deprecated. Replaced by getBox() |
void |
setBorder(java.lang.Byte border)
Deprecated. Replaced by getBox() |
void |
setBorderColor(java.awt.Color borderColor)
Deprecated. Replaced by getBox() |
void |
setBottomBorder(byte bottomBorder)
Deprecated. Replaced by getBox() |
void |
setBottomBorder(java.lang.Byte bottomBorder)
Deprecated. Replaced by getBox() |
void |
setBottomBorderColor(java.awt.Color bottomBorderColor)
Deprecated. Replaced by getBox() |
void |
setBottomPadding(int bottomPadding)
Deprecated. Replaced by getBox() |
void |
setBottomPadding(java.lang.Integer bottomPadding)
Deprecated. Replaced by getBox() |
void |
setBox(JRBox box)
Deprecated. Replaced by copyBox(JRLineBox) |
void |
setLeftBorder(byte leftBorder)
Deprecated. Replaced by getBox() |
void |
setLeftBorder(java.lang.Byte leftBorder)
Deprecated. Replaced by getBox() |
void |
setLeftBorderColor(java.awt.Color leftBorderColor)
Deprecated. Replaced by getBox() |
void |
setLeftPadding(int leftPadding)
Deprecated. Replaced by getBox() |
void |
setLeftPadding(java.lang.Integer leftPadding)
Deprecated. Replaced by getBox() |
void |
setPadding(int padding)
Deprecated. Replaced by getBox() |
void |
setPadding(java.lang.Integer padding)
Deprecated. Replaced by getBox() |
void |
setRightBorder(byte rightBorder)
Deprecated. Replaced by getBox() |
void |
setRightBorder(java.lang.Byte rightBorder)
Deprecated. Replaced by getBox() |
void |
setRightBorderColor(java.awt.Color rightBorderColor)
Deprecated. Replaced by getBox() |
void |
setRightPadding(int rightPadding)
Deprecated. Replaced by getBox() |
void |
setRightPadding(java.lang.Integer rightPadding)
Deprecated. Replaced by getBox() |
void |
setTopBorder(byte topBorder)
Deprecated. Replaced by getBox() |
void |
setTopBorder(java.lang.Byte topBorder)
Deprecated. Replaced by getBox() |
void |
setTopBorderColor(java.awt.Color topBorderColor)
Deprecated. Replaced by getBox() |
void |
setTopPadding(int topPadding)
Deprecated. Replaced by getBox() |
void |
setTopPadding(java.lang.Integer topPadding)
Deprecated. Replaced by getBox() |
void |
visit(JRVisitor visitor)
|
| Methods inherited from class net.sf.jasperreports.engine.design.JRDesignElement |
|---|
addPropertyExpression, getPropertyExpressions, getPropertyExpressionsList, removePropertyExpression, removePropertyExpression, setElementGroup, setHeight, setKey, setPrintWhenExpression, setPrintWhenGroupChanges, setStyle, setStyleNameReference, setY |
| 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.JRElement |
|---|
getElementGroup, getKey, getPositionType, getPositionTypeValue, getPrintWhenExpression, getPrintWhenGroupChanges, getPropertyExpressions, getStretchType, getStretchTypeValue, getX, getY, isPrintInFirstWholeBand, isPrintRepeatedValues, isPrintWhenDetailOverflows, isRemoveLineWhenBlank, setPositionType, setPositionType, setPrintInFirstWholeBand, setPrintRepeatedValues, setPrintWhenDetailOverflows, setRemoveLineWhenBlank, setStretchType, setStretchType, setWidth, setX |
| Methods inherited from interface net.sf.jasperreports.engine.JRCommonElement |
|---|
getBackcolor, getForecolor, getHeight, getMode, getOwnBackcolor, getOwnForecolor, getOwnMode, getOwnModeValue, getWidth, setBackcolor, setForecolor, setMode, setMode, setMode |
| Methods inherited from interface net.sf.jasperreports.engine.JRStyleContainer |
|---|
getDefaultStyleProvider, getStyle, getStyleNameReference |
| Methods inherited from interface net.sf.jasperreports.engine.JRPropertiesHolder |
|---|
getParentProperties, getPropertiesMap, hasProperties |
| Methods inherited from interface net.sf.jasperreports.engine.JRElementGroup |
|---|
getElementGroup |
| Methods inherited from interface net.sf.jasperreports.engine.JRChild |
|---|
clone |
| Field Detail |
|---|
public static final java.lang.String PROPERTY_CHILDREN
| Constructor Detail |
|---|
public JRDesignFrame(JRDefaultStyleProvider defaultStyleProvider)
defaultStyleProvider - default style provider instancepublic JRDesignFrame()
| Method Detail |
|---|
public void collectExpressions(JRExpressionCollector collector)
collectExpressions in interface JRElementpublic void visit(JRVisitor visitor)
visit in interface JRVisitablepublic JRElement[] getElements()
JRElementGroup
getElements in interface JRElementGrouppublic void addElement(JRElement element)
element - the element to add
public void addElement(int index,
JRElement element)
index - the element positionelement - the element to addpublic boolean removeElement(JRElement element)
element - the element to remove
public void addElementGroup(JRElementGroup group)
group - the element group to add
public void addElementGroup(int index,
JRElementGroup group)
index - the element group positiongroup - the element group to addpublic boolean removeElementGroup(JRElementGroup group)
group - the group to remove
public java.util.List getChildren()
JRElementGroup
getChildren in interface JRElementGrouppublic JRElement getElementByKey(java.lang.String elementKey)
JRElementGroup
getElementByKey in interface JRElementGrouppublic ModeEnum getModeValue()
JRCommonElement
getModeValue in interface JRCommonElementgetModeValue in class JRBaseElementpublic JRBox getBox()
getLineBox()
public JRLineBox getLineBox()
getLineBox in interface JRBoxContainerpublic void setBox(JRBox box)
copyBox(JRLineBox)
public void copyBox(JRLineBox lineBox)
public byte getBorder()
getBox()
getBorder in interface JRBoxpublic java.lang.Byte getOwnBorder()
getBox()
getOwnBorder in interface JRBoxpublic void setBorder(byte border)
getBox()
setBorder in interface JRBoxpublic void setBorder(java.lang.Byte border)
getBox()
setBorder in interface JRBoxpublic java.awt.Color getBorderColor()
getBox()
getBorderColor in interface JRBoxpublic java.awt.Color getOwnBorderColor()
getBox()
getOwnBorderColor in interface JRBoxpublic void setBorderColor(java.awt.Color borderColor)
getBox()
setBorderColor in interface JRBoxpublic int getPadding()
getBox()
getPadding in interface JRBoxpublic java.lang.Integer getOwnPadding()
getBox()
getOwnPadding in interface JRBoxpublic void setPadding(int padding)
getBox()
setPadding in interface JRBoxpublic void setPadding(java.lang.Integer padding)
getBox()
setPadding in interface JRBoxpublic byte getTopBorder()
getBox()
getTopBorder in interface JRBoxpublic java.lang.Byte getOwnTopBorder()
getBox()
getOwnTopBorder in interface JRBoxpublic void setTopBorder(byte topBorder)
getBox()
setTopBorder in interface JRBoxpublic void setTopBorder(java.lang.Byte topBorder)
getBox()
setTopBorder in interface JRBoxpublic java.awt.Color getTopBorderColor()
getBox()
getTopBorderColor in interface JRBoxpublic java.awt.Color getOwnTopBorderColor()
getBox()
getOwnTopBorderColor in interface JRBoxpublic void setTopBorderColor(java.awt.Color topBorderColor)
getBox()
setTopBorderColor in interface JRBoxpublic int getTopPadding()
getBox()
getTopPadding in interface JRBoxpublic java.lang.Integer getOwnTopPadding()
getBox()
getOwnTopPadding in interface JRBoxpublic void setTopPadding(int topPadding)
getBox()
setTopPadding in interface JRBoxpublic void setTopPadding(java.lang.Integer topPadding)
getBox()
setTopPadding in interface JRBoxpublic byte getLeftBorder()
getBox()
getLeftBorder in interface JRBoxpublic java.lang.Byte getOwnLeftBorder()
getBox()
getOwnLeftBorder in interface JRBoxpublic void setLeftBorder(byte leftBorder)
getBox()
setLeftBorder in interface JRBoxpublic void setLeftBorder(java.lang.Byte leftBorder)
getBox()
setLeftBorder in interface JRBoxpublic java.awt.Color getLeftBorderColor()
getBox()
getLeftBorderColor in interface JRBoxpublic java.awt.Color getOwnLeftBorderColor()
getBox()
getOwnLeftBorderColor in interface JRBoxpublic void setLeftBorderColor(java.awt.Color leftBorderColor)
getBox()
setLeftBorderColor in interface JRBoxpublic int getLeftPadding()
getBox()
getLeftPadding in interface JRBoxpublic java.lang.Integer getOwnLeftPadding()
getBox()
getOwnLeftPadding in interface JRBoxpublic void setLeftPadding(int leftPadding)
getBox()
setLeftPadding in interface JRBoxpublic void setLeftPadding(java.lang.Integer leftPadding)
getBox()
setLeftPadding in interface JRBoxpublic byte getBottomBorder()
getBox()
getBottomBorder in interface JRBoxpublic java.lang.Byte getOwnBottomBorder()
getBox()
getOwnBottomBorder in interface JRBoxpublic void setBottomBorder(byte bottomBorder)
getBox()
setBottomBorder in interface JRBoxpublic void setBottomBorder(java.lang.Byte bottomBorder)
getBox()
setBottomBorder in interface JRBoxpublic java.awt.Color getBottomBorderColor()
getBox()
getBottomBorderColor in interface JRBoxpublic java.awt.Color getOwnBottomBorderColor()
getBox()
getOwnBottomBorderColor in interface JRBoxpublic void setBottomBorderColor(java.awt.Color bottomBorderColor)
getBox()
setBottomBorderColor in interface JRBoxpublic int getBottomPadding()
getBox()
getBottomPadding in interface JRBoxpublic java.lang.Integer getOwnBottomPadding()
getBox()
getOwnBottomPadding in interface JRBoxpublic void setBottomPadding(int bottomPadding)
getBox()
setBottomPadding in interface JRBoxpublic void setBottomPadding(java.lang.Integer bottomPadding)
getBox()
setBottomPadding in interface JRBoxpublic byte getRightBorder()
getBox()
getRightBorder in interface JRBoxpublic java.lang.Byte getOwnRightBorder()
getBox()
getOwnRightBorder in interface JRBoxpublic void setRightBorder(byte rightBorder)
getBox()
setRightBorder in interface JRBoxpublic void setRightBorder(java.lang.Byte rightBorder)
getBox()
setRightBorder in interface JRBoxpublic java.awt.Color getRightBorderColor()
getBox()
getRightBorderColor in interface JRBoxpublic java.awt.Color getOwnRightBorderColor()
getBox()
getOwnRightBorderColor in interface JRBoxpublic void setRightBorderColor(java.awt.Color rightBorderColor)
getBox()
setRightBorderColor in interface JRBoxpublic int getRightPadding()
getBox()
getRightPadding in interface JRBoxpublic java.lang.Integer getOwnRightPadding()
getBox()
getOwnRightPadding in interface JRBoxpublic void setRightPadding(int rightPadding)
getBox()
setRightPadding in interface JRBoxpublic void setRightPadding(java.lang.Integer rightPadding)
getBox()
setRightPadding in interface JRBoxpublic java.awt.Color getDefaultLineColor()
getDefaultLineColor in interface JRBoxContainerpublic java.lang.Object clone()
clone in interface JRCloneableclone in class JRBaseElement
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||