Package net.sf.jasperreports.engine.design

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
public class JRDesignFrame extends JRDesignElement implements JRFrame
Implementation of JRFrame to be used at design time.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:

  • Field Details

  • Constructor Details

    • JRDesignFrame

      public JRDesignFrame(JRDefaultStyleProvider defaultStyleProvider)
      Creates a new frame object.
      Parameters:
      defaultStyleProvider - default style provider instance

    • JRDesignFrame

      public JRDesignFrame()
      Creates a new frame object.

  • Method Details

    • collectExpressions

      public void collectExpressions(JRExpressionCollector collector)
      Specified by:
      collectExpressions in interface JRElement

    • visit

      public void visit(JRVisitor visitor)
      Specified by:
      visit in interface JRVisitable

    • getElements

      public JRElement[] getElements()
      Description copied from interface: JRElementGroup
      Gets an array containing all the elements and element groups in the hierarchy.
      Specified by:
      getElements in interface JRElementGroup

    • addElement

      public void addElement(JRElement element)
      Adds a sub element to the frame.
      Parameters:
      element - the element to add

    • addElement

      public void addElement(int index, JRElement element)
      Inserts a sub element at specified position into the frame.
      Parameters:
      index - the element position
      element - the element to add

    • removeElement

      public boolean removeElement(JRElement element)
      Removes a sub element from the frame.
      Parameters:
      element - the element to remove
      Returns:
      true if this frame contained the specified element

    • addElementGroup

      public void addElementGroup(JRElementGroup group)
      Adds an element group to the frame.
      Parameters:
      group - the element group to add

    • addElementGroup

      public void addElementGroup(int index, JRElementGroup group)
      Inserts an element group at specified position into the frame.
      Parameters:
      index - the element group position
      group - the element group to add

    • removeElementGroup

      public boolean removeElementGroup(JRElementGroup group)
      Removes a group element from the frame.
      Parameters:
      group - the group to remove
      Returns:
      true if this frame contained the specified group

    • getChildren

      public List<JRChild> getChildren()
      Description copied from interface: JRElementGroup
      Gets a list of all direct children elements or elements groups.
      Specified by:
      getChildren in interface JRElementGroup

    • getElementByKey

      public JRElement getElementByKey(String elementKey)
      Description copied from interface: JRElementGroup
      Gets an element from this group, based on its element key.
      Specified by:
      getElementByKey in interface JRElementGroup

    • getMode

      public ModeEnum 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 interface JRCommonElement
      Overrides:
      getMode in class JRBaseElement

    • getLineBox

      public JRLineBox getLineBox()
      Specified by:
      getLineBox in interface JRBoxContainer

    • copyBox

      public void copyBox(JRLineBox lineBox)

    • getDefaultLineColor

      public Color getDefaultLineColor()
      Specified by:
      getDefaultLineColor in interface JRBoxContainer

    • getBorderSplitType

      public BorderSplitType getBorderSplitType()
      Description copied from interface: JRFrame
      Determines how should the frames borders behave when the frame splits on two pages.
      Specified by:
      getBorderSplitType in interface JRFrame
      Returns:
      the border split type
      See Also:

    • setBorderSplitType

      public void setBorderSplitType(BorderSplitType borderSplitType)
      Sets the border split type for the frame.
      Parameters:
      borderSplitType - the border split type
      See Also:

    • clone

      public Object clone()
      Specified by:
      clone in interface JRCloneable
      Overrides:
      clone in class JRDesignElement