RMFlowLayoutBasic (ReportMill 13 API)

java.lang.Object
- com.reportmill.shape.RMShapeLayout
- - com.reportmill.shape.RMFlowLayoutBasic

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

RMFlowLayout
```
public class RMFlowLayoutBasic
extends RMShapeLayout
implements java.beans.PropertyChangeListener
```
A layout that arranges children one after another in a manner like text flow, with text like controls in the constraints to provide for newline like ability to define the start of a new row and tab like ability to allow for lining up children in different rows. For instance: add(button, "n"), adds a button followed by a "newline". Newline modifiers can be "left", "center", "right" and "full" (l,c,r,f) to specify the alignment of children in the line. Another constraint option is tab ("t") to specify that a components in successive lines that also include a tab are aligned. Tab can also have the modifiers "left", "center", "right", "full" (l,c,r,f) to specify how children preceding the tab are aligned with respect to the tab. Another constraint is "s", allowing the insertion of additional space after a child with a number specifying the number of points for the space (eg., "5s").

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RMFlowLayoutBasic.AlignX`
`static class`	`RMFlowLayoutBasic.AlignY`
`class`	`RMFlowLayoutBasic.FlowTab` A class to represent a tab area of children in a flow layout (a column o)f a line).
`static class`	`RMFlowLayoutBasic.LayoutInfo` A class to hold constraints for child.

Nested classes/interfaces inherited from class com.reportmill.shape.RMShapeLayout
RMShapeLayout.DirectLayout, RMShapeLayout.FrameLayout

Constructor Summary

Constructors
Constructor and Description

RMFlowLayoutBasic()

Constructors
Constructor and Description
`RMFlowLayoutBasic()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLayoutChild(RMShape aChild)` Override to start listening to child property changes.
`RMFlowLayout`	`clone()` Standard clone implementation.
`RMFlowLayoutBasic.AlignX`	`getAlignX()` Returns the horizontal alignment.
`RMFlowLayoutBasic.AlignY`	`getAlignY()` Returns the vertical alignment.
`RMShape`	`getChild(int anIndex)` Returns the individual child in this line.
`int`	`getChildCount()` Returns the number of children in this line.
`double`	`getHeight()`
`RMFlowLayoutBasic.LayoutInfo`	`getLayoutInfoX(RMShape aChild)` Returns the constraints in a given child.
`double`	`getMaxX()`
`double`	`getMaxY()`
`RMSize`	`getPreferredSize(RMShape aParent, float aMaxWidth, float aMaxHeight)` Returns the preferred size.
`int`	`getSpacingX()` Returns the horizontal spacing between children.
`int`	`getSpacingY()` Returns the vertical spacing between children.
`RMFlowLayoutBasic.FlowTab`	`getTab(int anIndex)` Returns the individual tab at the given index.
`int`	`getTabCount()` Returns the number of tabs in layout.
`double`	`getWidth()`
`boolean`	`getWraps()` Returns whether to wrap children to bounds of parent.
`double`	`getX()` Returns line x, y, width, height.
`double`	`getY()`
`boolean`	`isLocked()` Returns whether line is locked.
`void`	`layoutParent(RMShape aParent)` Override to perform layout.
`void`	`propertyChange(java.beans.PropertyChangeEvent anEvent)` Catch child size changes (when not doing layout) to set minimum size.
`void`	`removeLayoutChild(RMShape aChild)` Override to remove constraints from children.
`void`	`setAlignX(RMFlowLayoutBasic.AlignX anAlign)` Sets the horizontal alignment.
`void`	`setAlignY(RMFlowLayoutBasic.AlignY anAlign)` Sets the vertical alignment.
`void`	`setLocked(boolean aFlag)` Sets whether line is locked.
`void`	`setSpacingX(int aSpacing)` Sets the horizontal spacing between children.
`void`	`setSpacingY(int aSpacing)` Sets the vertical spacing between children.
`void`	`setWraps(boolean aValue)` Sets whether to wrap children to bounds of parent.

Methods inherited from class com.reportmill.shape.RMShapeLayout
doLayout, fromXML, getMaximumSize, getMinimumSize, getParent, isHittableChild, isValid, isValidating, isVisibleChild, paintLayout, reset, setBestHeight, setLayoutInfoX, setParent, setValid, toXML

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RMFlowLayoutBasic
```
public RMFlowLayoutBasic()
```
- Method Detail
  - getSpacingX
```
public int getSpacingX()
```
    Returns the horizontal spacing between children.
  - setSpacingX
```
public void setSpacingX(int aSpacing)
```
    Sets the horizontal spacing between children.
  - getSpacingY
```
public int getSpacingY()
```
    Returns the vertical spacing between children.
  - setSpacingY
```
public void setSpacingY(int aSpacing)
```
    Sets the vertical spacing between children.
  - getAlignX
```
public RMFlowLayoutBasic.AlignX getAlignX()
```
    Returns the horizontal alignment.
  - setAlignX
```
public void setAlignX(RMFlowLayoutBasic.AlignX anAlign)
```
    Sets the horizontal alignment.
  - getAlignY
```
public RMFlowLayoutBasic.AlignY getAlignY()
```
    Returns the vertical alignment.
  - setAlignY
```
public void setAlignY(RMFlowLayoutBasic.AlignY anAlign)
```
    Sets the vertical alignment.
  - getWraps
```
public boolean getWraps()
```
    Returns whether to wrap children to bounds of parent.
  - setWraps
```
public void setWraps(boolean aValue)
```
    Sets whether to wrap children to bounds of parent.
  - getChildCount
```
public int getChildCount()
```
    Returns the number of children in this line.
  - getChild
```
public RMShape getChild(int anIndex)
```
    Returns the individual child in this line.
  - getX
```
public double getX()
```
    Returns line x, y, width, height.
  - getY
```
public double getY()
```
  - getWidth
```
public double getWidth()
```
  - getHeight
```
public double getHeight()
```
  - getMaxX
```
public double getMaxX()
```
  - getMaxY
```
public double getMaxY()
```
  - addLayoutChild
```
public void addLayoutChild(RMShape aChild)
```
    Override to start listening to child property changes.
    
    Overrides:
    
    addLayoutChild in class RMShapeLayout
  - removeLayoutChild
```
public void removeLayoutChild(RMShape aChild)
```
    Override to remove constraints from children.
    
    Overrides:
    
    removeLayoutChild in class RMShapeLayout
  - getLayoutInfoX
```
public RMFlowLayoutBasic.LayoutInfo getLayoutInfoX(RMShape aChild)
```
    Returns the constraints in a given child.
    
    Overrides:
    
    getLayoutInfoX in class RMShapeLayout
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent anEvent)
```
    Catch child size changes (when not doing layout) to set minimum size.
    
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
  - layoutParent
```
public void layoutParent(RMShape aParent)
```
    Override to perform layout.
    
    Overrides:
    
    layoutParent in class RMShapeLayout
  - getPreferredSize
```
public RMSize getPreferredSize(RMShape aParent,
                      float aMaxWidth,
                      float aMaxHeight)
```
    Returns the preferred size.
    
    Overrides:
    
    getPreferredSize in class RMShapeLayout
  - getTabCount
```
public int getTabCount()
```
    Returns the number of tabs in layout.
  - getTab
```
public RMFlowLayoutBasic.FlowTab getTab(int anIndex)
```
    Returns the individual tab at the given index.
  - isLocked
```
public boolean isLocked()
```
    Returns whether line is locked.
  - setLocked
```
public void setLocked(boolean aFlag)
```
    Sets whether line is locked.
  - clone
```
public RMFlowLayout clone()
```
    Standard clone implementation.
    
    Overrides:
    
    clone in class RMShapeLayout

Class RMFlowLayoutBasic

Nested Class Summary

Nested classes/interfaces inherited from class com.reportmill.shape.RMShapeLayout

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.shape.RMShapeLayout

Methods inherited from class java.lang.Object

Constructor Detail

RMFlowLayoutBasic

Method Detail

getSpacingX

setSpacingX

getSpacingY

setSpacingY

getAlignX

setAlignX

getAlignY

setAlignY

getWraps

setWraps

getChildCount

getChild

getX

getY

getWidth

getHeight

getMaxX

getMaxY

addLayoutChild

removeLayoutChild

getLayoutInfoX

propertyChange

layoutParent

getPreferredSize

getTabCount

getTab

isLocked

setLocked

clone