com.reportmill.shape

Class RMShapeLayout

java.lang.Object

com.reportmill.shape.RMShapeLayout

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

RMCrossTabLayout, RMDocumentLayout, RMFlowLayoutBasic, RMGraphArea.GraphAreaLayout, RMShapeLayout.DirectLayout, RMShapeLayout.FrameLayout, RMSpringLayout, RMTable.TableLayout

public class RMShapeLayout
extends java.lang.Object
implements java.lang.Cloneable

Handles code for laying out shape children with springs and struts.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RMShapeLayout.DirectLayout A shape layout that calls shape layoutChildren() method.
static class	RMShapeLayout.FrameLayout A shape layout subclass that just puts the child exactly in the parent bounds.

Constructor Summary

Constructors

Constructor and Description
RMShapeLayout() Creates a new layout.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutChild(RMShape aChild) Called when a child is added to parent shape.
RMShapeLayout	clone() Standard clone implementation.
void	doLayout(RMShape aParent) Performs layout.
java.lang.Object	fromXML(com.reportmill.archiver.RXArchiver anArchiver, com.reportmill.archiver.RXElement anElement, java.lang.Object anOwner) XML Unarchival.
java.lang.Object	getLayoutInfoX(RMShape aChild) Returns extended layout info for a child.
RMSize	getMaximumSize(RMShape aShape) Returns the maximum size of the shape.
RMSize	getMinimumSize(RMShape aShape) Returns the minimum size of the shape.
RMShape	getParent() Returns the parent for this layout.
RMSize	getPreferredSize(RMShape aShape, float aMaxWidth, float aMaxHeight) Returns the preferred size of the shape.
boolean	isHittableChild(RMShape aParent, RMShape aChild) Returns whether given child shape is hittable according to given parent shape.
boolean	isValid() Returns whether layout needs to be done.
boolean	isValidating() Returns whether layout is validating (laying out shape).
boolean	isVisibleChild(RMShape aParent, RMShape aChild) Returns whether given child shape is visible to given parent shape.
void	layoutParent(RMShape aParent) Performs layout.
void	paintLayout(java.awt.Graphics2D aGraphics) Paint layout.
void	removeLayoutChild(RMShape aChild) Called when a child is removed from parent shape.
void	reset() Resets shape layout without doing layout.
void	setBestHeight(RMShape aShape) Sets the shape to its preferred height.
void	setLayoutInfoX(RMShape aChild, java.lang.Object theInfo) Sets extended layout info for a child.
void	setParent(RMShape aShape) Sets the parent for this layout.
void	setValid(boolean aValue) Sets whether layout needs to be done.
com.reportmill.archiver.RXElement	toXML(com.reportmill.archiver.RXArchiver anArchiver, java.lang.Object anOwner) XML Archival.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RMShapeLayout

public RMShapeLayout()

Creates a new layout.

Method Detail

getParent

public RMShape getParent()

Returns the parent for this layout.

setParent

public void setParent(RMShape aShape)

Sets the parent for this layout.

reset

public void reset()

Resets shape layout without doing layout.

isValid

public boolean isValid()

Returns whether layout needs to be done.

setValid

public void setValid(boolean aValue)

Sets whether layout needs to be done.

isValidating

public boolean isValidating()

Returns whether layout is validating (laying out shape).

doLayout

public void doLayout(RMShape aParent)

Performs layout.

layoutParent

public void layoutParent(RMShape aParent)

Performs layout.

getMinimumSize

public RMSize getMinimumSize(RMShape aShape)

Returns the minimum size of the shape.

getMaximumSize

public RMSize getMaximumSize(RMShape aShape)

Returns the maximum size of the shape.

getPreferredSize

public RMSize getPreferredSize(RMShape aShape,
                      float aMaxWidth,
                      float aMaxHeight)

Returns the preferred size of the shape.

setBestHeight

public void setBestHeight(RMShape aShape)

Sets the shape to its preferred height.

addLayoutChild

public void addLayoutChild(RMShape aChild)

Called when a child is added to parent shape.

removeLayoutChild

public void removeLayoutChild(RMShape aChild)

Called when a child is removed from parent shape.

getLayoutInfoX

public java.lang.Object getLayoutInfoX(RMShape aChild)

Returns extended layout info for a child.

setLayoutInfoX

public void setLayoutInfoX(RMShape aChild,
                  java.lang.Object theInfo)

Sets extended layout info for a child.

paintLayout

public void paintLayout(java.awt.Graphics2D aGraphics)

Paint layout.

isVisibleChild

public boolean isVisibleChild(RMShape aParent,
                     RMShape aChild)

Returns whether given child shape is visible to given parent shape.

isHittableChild

public boolean isHittableChild(RMShape aParent,
                      RMShape aChild)

Returns whether given child shape is hittable according to given parent shape.

clone

public RMShapeLayout clone()

Standard clone implementation.

Overrides:

clone in class java.lang.Object

toXML

public com.reportmill.archiver.RXElement toXML(com.reportmill.archiver.RXArchiver anArchiver,
                                      java.lang.Object anOwner)

XML Archival.

fromXML

public java.lang.Object fromXML(com.reportmill.archiver.RXArchiver anArchiver,
                       com.reportmill.archiver.RXElement anElement,
                       java.lang.Object anOwner)

XML Unarchival.