Module org.jfree.chart3d
Package org.jfree.chart3d.table

Class VerticalFlowElement

java.lang.Object
org.jfree.chart3d.table.AbstractTableElement
org.jfree.chart3d.table.VerticalFlowElement
All Implemented Interfaces:
Serializable, ContainerElement, TableElement
public class VerticalFlowElement extends AbstractTableElement implements ContainerElement, Serializable
A table element that displays a list of sub-elements in a vertical flow layout.

NOTE: This class is serializable, but the serialization format is subject to change in future releases and should not be relied upon for persisting instances of this class.
Since:
1.1
See Also:

  • Constructor Details

    • VerticalFlowElement

      public VerticalFlowElement()
      Creates a new instance (equivalent to new VerticalFlowElement(VAlign.MIDDLE, 2)).

    • VerticalFlowElement

      public VerticalFlowElement(VAlign alignment, int vgap)
      Creates a new instance.
      Parameters:
      alignment - the vertical alignment of columns (null not permitted).
      vgap - the gap between elements.

  • Method Details

    • getVerticalAlignment

      public VAlign getVerticalAlignment()
      Returns the vertical alignment for the elements.
      Returns:
      The vertical alignment (never null).

    • setVerticalAlignment

      public void setVerticalAlignment(VAlign alignment)
      Sets the vertical alignment of elements within columns,
      Parameters:
      alignment - the alignment (null not permitted).

    • getVGap

      public int getVGap()
      Returns the vertical gap between elements, in Java2D units.
      Returns:
      The vertical gap.

    • setVGap

      public void setVGap(int vgap)
      Sets the vertical gap between elements.
      Parameters:
      vgap - the gap (in Java2D units).

    • getElements

      public List<TableElement> getElements()
      Returns a (new) list containing the elements in this flow layout.
      Returns:
      A list containing the elements (possibly empty, but never null).

    • addElement

      public void addElement(TableElement element)
      Adds a sub-element to the list.
      Specified by:
      addElement in interface ContainerElement
      Parameters:
      element - the element (null not permitted).

    • receive

      public void receive(TableElementVisitor visitor)
      Receives a TableElementVisitor (the visitor will be received by all the elements in the flow).
      Specified by:
      receive in interface TableElement
      Parameters:
      visitor - the visitor (null not permitted).
      Since:
      1.2

    • preferredSize

      public Dimension2D preferredSize(Graphics2D g2, Rectangle2D bounds, Map<String,Object> constraints)
      Returns the preferred size for the element.
      Specified by:
      preferredSize in interface TableElement
      Specified by:
      preferredSize in class AbstractTableElement
      Parameters:
      g2 - the graphics target (null not permitted).
      bounds - the bounds (null not permitted).
      constraints - the layout constraints (ignored here).
      Returns:
      The preferred size (never null).

    • layoutElements

      public List<Rectangle2D> layoutElements(Graphics2D g2, Rectangle2D bounds, Map<String,Object> constraints)
      Description copied from interface: TableElement
      Performs a layout of this table element, returning a list of bounding rectangles for the element and its subelements. This method is typically called by the TableElement.draw(java.awt.Graphics2D, java.awt.geom.Rectangle2D) method.
      Specified by:
      layoutElements in interface TableElement
      Parameters:
      g2 - the graphics target (null not permitted).
      bounds - the bounds (null not permitted).
      constraints - the constraints (if any).
      Returns:
      A list of bounding rectangles.

    • draw

      public void draw(Graphics2D g2, Rectangle2D bounds)
      Draws the element and all of its subelements within the specified bounds.
      Specified by:
      draw in interface TableElement
      Parameters:
      g2 - the graphics target (null not permitted).
      bounds - the bounds (null not permitted).

    • draw

      public void draw(Graphics2D g2, Rectangle2D bounds, TableElementOnDraw onDrawHandler)
      Draws the element within the specified bounds. If the recordBounds flag is set, this element and each of its children will have its BOUNDS_2D property updated with the current bounds.
      Specified by:
      draw in interface TableElement
      Parameters:
      g2 - the graphics target (null not permitted).
      bounds - the bounds (null not permitted).
      onDrawHandler - record the bounds?
      Since:
      1.3

    • equals

      public boolean equals(Object obj)
      Tests this element for equality with an arbitrary object.
      Overrides:
      equals in class AbstractTableElement
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.