oracle.ide.controls
Class PentaLayout

java.lang.Object
  oracle.ide.controls.PentaLayout

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2

public final class PentaLayout

extends java.lang.Object

implements java.awt.LayoutManager2

PentaLayout is an equivalent to BorderLayout. The layout geometry is adaptable with setStyle.

Field Summary

static byte	C_STYLE Layouts the components like this:
static java.lang.Integer	CENTER
static byte	CORNER_NORTH_EAST OR'ed with other CORNER_ constants to build a style.
static byte	CORNER_NORTH_WEST OR'ed with other CORNER_ constants to build a style.
static byte	CORNER_SOUTH_EAST OR'ed with other CORNER_ constants to build a style.
static byte	CORNER_SOUTH_WEST OR'ed with other CORNER_ constants to build a style.
static java.lang.Integer	EAST
static byte	HORIZONTAL_STYLE Layouts the components like this:
static java.lang.Integer	NORTH
static java.lang.Integer	SOUTH
static byte	T_STYLE Layouts the components like this:
static byte	VERTICAL_STYLE Layouts the components like this:
static java.lang.Integer	WEST

Constructor Summary

PentaLayout()
Constructs a new border layout with HORIZONTAL_STYLE and no gaps between components.

PentaLayout(byte style, int hgap, int vgap)
Constructs a border layout with the specified style and gaps between components.

PentaLayout(int hgap, int vgap)
Constructs a border layout with an horizontal style and the specified gaps between components.

Method Summary

void	addLayoutComponent(java.awt.Component comp, java.lang.Object constraints) Adds the specified component to the layout, using the specified constraint object.
void	addLayoutComponent(java.lang.String name, java.awt.Component comp)
static java.lang.String	getBorderLayoutEquivalent(java.lang.Integer constraint)
int	getHgap() Returns the horizontal gap between components.
float	getLayoutAlignmentX(java.awt.Container parent) Returns the alignment along the x axis.
float	getLayoutAlignmentY(java.awt.Container parent) Returns the alignment along the y axis.
byte	getStyle() gets the layout style
int	getVgap() Returns the vertical gap between components.
void	invalidateLayout(java.awt.Container target) Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
void	layoutContainer(java.awt.Container target) Lays out the container argument using this border layout.
java.awt.Dimension	maximumLayoutSize(java.awt.Container target) Returns the maximum dimensions for this layout given the components in the specified target container.
java.awt.Dimension	minimumLayoutSize(java.awt.Container target) Determines the minimum size of the target container using this layout manager.
java.awt.Dimension	preferredLayoutSize(java.awt.Container target) Determines the preferred size of the target container using this layout manager, based on the components in the container.
void	removeLayoutComponent(java.awt.Component comp) Removes the specified component from this border layout.
static java.lang.Integer	reverseConstraint(java.lang.Integer constraint)
void	setHgap(int hgap) Sets the horizontal gap between components.
void	setStyle(byte style) Sets the layout style.
void	setVgap(int vgap) Sets the vertical gap between components.
java.lang.String	toString() Returns a string representation of the state of this border layout.

Methods inherited from class java.lang.Object

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

Field Detail

CENTER

public static final java.lang.Integer CENTER

NORTH

public static final java.lang.Integer NORTH

SOUTH

public static final java.lang.Integer SOUTH

WEST

public static final java.lang.Integer WEST

EAST

public static final java.lang.Integer EAST

CORNER_NORTH_WEST

public static final byte CORNER_NORTH_WEST

OR'ed with other CORNER_ constants to build a style.

See Also:

setStyle(byte), Constant Field Values

CORNER_NORTH_EAST

public static final byte CORNER_NORTH_EAST

OR'ed with other CORNER_ constants to build a style.

See Also:

setStyle(byte), Constant Field Values

CORNER_SOUTH_WEST

public static final byte CORNER_SOUTH_WEST

OR'ed with other CORNER_ constants to build a style.

See Also:

setStyle(byte), Constant Field Values

CORNER_SOUTH_EAST

public static final byte CORNER_SOUTH_EAST

OR'ed with other CORNER_ constants to build a style.

See Also:

setStyle(byte), Constant Field Values

HORIZONTAL_STYLE

public static final byte HORIZONTAL_STYLE

Layouts the components like this:

See Also:

setStyle(byte), Constant Field Values

VERTICAL_STYLE

public static final byte VERTICAL_STYLE

Layouts the components like this:

See Also:

setStyle(byte), Constant Field Values

C_STYLE

public static final byte C_STYLE

Layouts the components like this:

See Also:

setStyle(byte), Constant Field Values

T_STYLE

public static final byte T_STYLE

Layouts the components like this:

See Also:

setStyle(byte), Constant Field Values

Constructor Detail

PentaLayout

public PentaLayout()

Constructs a new border layout with HORIZONTAL_STYLE and no gaps between components.

PentaLayout

public PentaLayout(int hgap,
                   int vgap)

Constructs a border layout with an horizontal style and the specified gaps between components.

Parameters:

hgap - the horizontal gap.

vgap - the vertical gap.

PentaLayout

public PentaLayout(byte style,
                   int hgap,
                   int vgap)

Constructs a border layout with the specified style and gaps between components.

Parameters:

hgap - the horizontal gap.

vgap - the vertical gap.

Method Detail

getHgap

public int getHgap()

Returns the horizontal gap between components.

setHgap

public void setHgap(int hgap)

Sets the horizontal gap between components.

Parameters:

hgap - the horizontal gap between components

getVgap

public int getVgap()

Returns the vertical gap between components.

setVgap

public void setVgap(int vgap)

Sets the vertical gap between components.

Parameters:

vgap - the vertical gap between components

setStyle

public void setStyle(byte style)

Sets the layout style. You should normally pickup one of the XXX_STYLE constants but if you are imaginative and like the risk, you can invent one.

Parameters:

style - one of the XXX_STYLE constants

getStyle

public byte getStyle()

gets the layout style

See Also:

setStyle(byte)

addLayoutComponent

public void addLayoutComponent(java.awt.Component comp,
                               java.lang.Object constraints)

Adds the specified component to the layout, using the specified constraint object. For border layouts, the constraint must be one of the following constants: NORTH, SOUTH, EAST, WEST, or CENTER.

Most applications do not call this method directly. This method is called when a component is added to a container using the Container.add method with the same argument types.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

Parameters:

comp - the component to be added.

constraints - an object that specifies how and where the component is added to the layout.

Throws:

java.lang.IllegalArgumentException - if the constraint object is not one of the five specified constants.

See Also:

Container.add(java.awt.Component, java.lang.Object)

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                               java.awt.Component comp)

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component comp)

Removes the specified component from this border layout. This method is called when a container calls its remove or removeAll methods. Most applications do not call this method directly.

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

Parameters:

comp - the component to be removed.

See Also:

Container.remove(java.awt.Component), Container.removeAll()

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container target)

Determines the minimum size of the target container using this layout manager.

This method is called when a container calls its getMinimumSize method. Most applications do not call this method directly.

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

Returns:

the minimum dimensions needed to lay out the subcomponents of the specified container.

See Also:

Container, preferredLayoutSize(java.awt.Container), Container.getMinimumSize()

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container target)

Determines the preferred size of the target container using this layout manager, based on the components in the container.

Most applications do not call this method directly. This method is called when a container calls its getPreferredSize method.

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

Returns:

the preferred dimensions to lay out the subcomponents of the specified container.

See Also:

Container, minimumLayoutSize(java.awt.Container), Container.getPreferredSize()

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container target)

Returns the maximum dimensions for this layout given the components in the specified target container.

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

Parameters:

target - the component which needs to be laid out

See Also:

Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container parent)

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container parent)

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

invalidateLayout

public void invalidateLayout(java.awt.Container target)

Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

layoutContainer

public void layoutContainer(java.awt.Container target)

Lays out the container argument using this border layout.

This method actually reshapes the components in the specified container in order to satisfy the constraints of this PentaLayout object. The NORTH and SOUTH components, if any, are placed at the top and bottom of the container, respectively. The WEST and EAST components are then placed on the left and right, respectively. Finally, the CENTER object is placed in any remaining space in the middle.

Most applications do not call this method directly. This method is called when a container calls its doLayout method.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

target - the container in which to do the layout.

See Also:

Container, Container.doLayout()

getBorderLayoutEquivalent

public static java.lang.String getBorderLayoutEquivalent(java.lang.Integer constraint)

reverseConstraint

public static java.lang.Integer reverseConstraint(java.lang.Integer constraint)

toString

public java.lang.String toString()

Returns a string representation of the state of this border layout.

Returns:

a string representation of this layout.