Package org.pentaho.reporting.tools.configeditor.util

Class VerticalLayout

java.lang.Object

org.pentaho.reporting.tools.configeditor.util.VerticalLayout

All Implemented Interfaces:

LayoutManager

public class VerticalLayout
extends Object
implements LayoutManager

A simple layout manager, which aligns all components in a vertical flow layout.

Author:

Thomas Morgner

Constructor Summary

Constructors

Constructor	Description
VerticalLayout()	DefaultConstructor.
VerticalLayout(boolean useParent)	Creates a new vertical layout.

Method Summary

Modifier and Type	Method	Description
void	addLayoutComponent(String name, Component comp)	Adds the specified component with the specified name to the layout.
boolean	isUseSizeFromParent()	Returns, whether the parent's defined size is used during the layouting, or whether the childs are used to compute the size.
void	layoutContainer(Container parent)	Lays out the container in the specified panel.
Dimension	minimumLayoutSize(Container parent)	Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.
Dimension	preferredLayoutSize(Container parent)	Calculates the preferred size dimensions for the specified panel given the components in the specified parent container.
void	removeLayoutComponent(Component comp)	Removes the specified component from the layout.

Methods inherited from class java.lang.Object

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

Constructor Detail

VerticalLayout

public VerticalLayout()

DefaultConstructor.

VerticalLayout

public VerticalLayout(boolean useParent)

Creates a new vertical layout. If useParent is set to true, the parents size will be used when performing the layouting, else only the parents childs are used to compute the layout.

Parameters:

useParent - defines, whether the parent's size is used.

Method Detail

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

Adds the specified component with the specified name to the layout.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the component name

comp - the component to be added

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Removes the specified component from the layout.

Specified by:

removeLayoutComponent in interface LayoutManager

Parameters:

comp - the component to be removed

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Calculates the preferred size dimensions for the specified panel given the components in the specified parent container.

Specified by:

preferredLayoutSize in interface LayoutManager

Parameters:

parent - the component to be laid out

Returns:

the preferred layout size

See Also:

minimumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Calculates the minimum size dimensions for the specified panel given the components in the specified parent container.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

parent - the component to be laid out

Returns:

the minimul layoutsize

See Also:

preferredLayoutSize(java.awt.Container)

isUseSizeFromParent

public boolean isUseSizeFromParent()

Returns, whether the parent's defined size is used during the layouting, or whether the childs are used to compute the size.

Returns:

true, if the parent's size is used, false otherwise.

layoutContainer

public void layoutContainer(Container parent)

Lays out the container in the specified panel.

Specified by:

layoutContainer in interface LayoutManager

Parameters:

parent - the component which needs to be laid out