com.sibvisions.rad.ui.swing.impl.layout
Class AwtFormLayout

java.lang.Object
  com.sibvisions.rad.ui.awt.impl.AwtResource<JVxFormLayout>
      com.sibvisions.rad.ui.swing.impl.layout.AwtFormLayout

All Implemented Interfaces:

IAlignmentConstants, ILayout<IFormLayout.IConstraints>, IResource, IFormLayout

public class AwtFormLayout
extends AwtResource<JVxFormLayout>
implements IFormLayout

The AwtFormLayout is the IFormLayout implementation for AWT.

See Also:

JVxFormLayout

Nested Class Summary

static class	AwtFormLayout.AwtAnchor The Anchor gives the possible horizontal and vertical positions.
static class	AwtFormLayout.AwtConstraints The Constraint stores the top, left, bottom and right Anchor for layouting a component.

Nested classes/interfaces inherited from interface javax.rad.ui.layout.IFormLayout

IFormLayout.IAnchor, IFormLayout.IConstraints

Field Summary

Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource

resource

Fields inherited from interface javax.rad.ui.layout.IFormLayout

NEWLINE

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

AwtFormLayout()
Creates a new instance of AwtSimpleFormLayout based on an IFormLayout implementation.

Method Summary

IFormLayout.IAnchor	createAnchor(IFormLayout.IAnchor pRelatedAnchor) Constructs an anchor relative to pRelatedAnchor auto sized.
IFormLayout.IAnchor	createAnchor(IFormLayout.IAnchor pRelatedAnchor, int pPosition) Constructs an anchor relative to pRelatedAnchor with pPosition pixels.
IFormLayout.IAnchor	getBottomAnchor() Returns the bottom border anchor.
IFormLayout.IAnchor	getBottomMarginAnchor() Returns the bottom margin border anchor.
IFormLayout.IConstraints	getConstraints(IComponent pComponent) Gets the constraints for the specified IComponent.
IFormLayout.IConstraints	getConstraints(IFormLayout.IAnchor pTopAnchor, IFormLayout.IAnchor pLeftAnchor) Gets the constraints for the left corner, specified through anchors.
IFormLayout.IConstraints	getConstraints(IFormLayout.IAnchor pTopAnchor, IFormLayout.IAnchor pLeftAnchor, IFormLayout.IAnchor pBottomAnchor, IFormLayout.IAnchor pRightAnchor) Creates the default constraints for the given anchors.
IFormLayout.IConstraints	getConstraints(int pColumn, int pRow) Creates the default constraints for the given column and row.
IFormLayout.IConstraints	getConstraints(int pBeginColumn, int pBeginRow, int pEndColumn, int pEndRow) Creates the default constraints for the given column and row.
int	getHorizontalAlignment() Returns the alignment along the x axis.
IFormLayout.IAnchor[]	getHorizontalAnchors() Returns all horizontal anchors used by this layout.
int	getHorizontalGap() Returns the horizontal gap between components.
IFormLayout.IAnchor	getLeftAnchor() Returns the left border anchor.
IFormLayout.IAnchor	getLeftMarginAnchor() Returns the left margin border anchor.
IInsets	getMargins() Gets the margins.
int	getNewlineCount() Gets the new line count.
IFormLayout.IAnchor	getRightAnchor() Returns the right border anchor.
IFormLayout.IAnchor	getRightMarginAnchor() Returns the right margin border anchor.
IFormLayout.IAnchor	getTopAnchor() Returns the top border anchor.
IFormLayout.IAnchor	getTopMarginAnchor() Returns the top margin border anchor.
int	getVerticalAlignment() Returns the alignment along the y axis.
IFormLayout.IAnchor[]	getVerticalAnchors() Returns all vertical anchors used by this layout.
int	getVerticalGap() Returns the vertical gap between components.
void	setConstraints(IComponent pComponent, IFormLayout.IConstraints pConstraints) Sets the constraints for the specified IComponent.
void	setHorizontalAlignment(int pHorizontalAlignment) Sets the horizontal alignment.
void	setHorizontalGap(int pHgap) Sets the horizontal gap between components.
void	setMargins(IInsets pMargins) Sets the margins.
void	setNewlineCount(int pNewlineCount) Sets the new line count.
void	setVerticalAlignment(int pVerticalAlignment) Sets the vertical alignment.
void	setVerticalGap(int pVgap) Sets the vertical gap between components.

Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource

equals, getResource, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.rad.ui.IResource

getResource

Constructor Detail

AwtFormLayout

public AwtFormLayout()

Creates a new instance of AwtSimpleFormLayout based on an IFormLayout implementation.

See Also:

IFormLayout

Method Detail

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. Possible values are defined in AlignmentConstants.

Specified by:

getHorizontalAlignment in interface IAlignmentConstants

Returns:

the horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(int pHorizontalAlignment)

Sets the horizontal alignment. Possible values are defined in AlignmentConstants.

Specified by:

setHorizontalAlignment in interface IAlignmentConstants

Parameters:

pHorizontalAlignment - the new vertical alignment

getVerticalAlignment

public int getVerticalAlignment()

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. Possible values are defined in AlignmentConstants.

Specified by:

getVerticalAlignment in interface IAlignmentConstants

Returns:

the vertical alignment

setVerticalAlignment

public void setVerticalAlignment(int pVerticalAlignment)

Sets the vertical alignment. Possible values are defined in AlignmentConstants.

Specified by:

setVerticalAlignment in interface IAlignmentConstants

Parameters:

pVerticalAlignment - the new vertical alignment

getHorizontalGap

public int getHorizontalGap()

Returns the horizontal gap between components.

Specified by:

getHorizontalGap in interface ILayout<IFormLayout.IConstraints>

Returns:

returns the horizontal gap between components.

setHorizontalGap

public void setHorizontalGap(int pHgap)

Sets the horizontal gap between components.

Specified by:

setHorizontalGap in interface ILayout<IFormLayout.IConstraints>

Parameters:

pHgap - the horizontal gap between components.

getVerticalGap

public int getVerticalGap()

Returns the vertical gap between components.

Specified by:

getVerticalGap in interface ILayout<IFormLayout.IConstraints>

Returns:

returns the vertical gap between components.

setVerticalGap

public void setVerticalGap(int pVgap)

Sets the vertical gap between components.

Specified by:

setVerticalGap in interface ILayout<IFormLayout.IConstraints>

Parameters:

pVgap - the vertical gap between components

getMargins

public IInsets getMargins()

Gets the margins.

Specified by:

getMargins in interface ILayout<IFormLayout.IConstraints>

Returns:

the margins.

setMargins

public void setMargins(IInsets pMargins)

Sets the margins.

Specified by:

setMargins in interface ILayout<IFormLayout.IConstraints>

Parameters:

pMargins - the margins.

getNewlineCount

public int getNewlineCount()

Gets the new line count.

Specified by:

getNewlineCount in interface IFormLayout

Returns:

the new line count.

setNewlineCount

public void setNewlineCount(int pNewlineCount)

Sets the new line count.

Specified by:

setNewlineCount in interface IFormLayout

Parameters:

pNewlineCount - the new line count.

getLeftAnchor

public IFormLayout.IAnchor getLeftAnchor()

Returns the left border anchor.

Specified by:

getLeftAnchor in interface IFormLayout

Returns:

the left border anchor.

getRightAnchor

public IFormLayout.IAnchor getRightAnchor()

Returns the right border anchor.

Specified by:

getRightAnchor in interface IFormLayout

Returns:

the right border anchor.

getTopAnchor

public IFormLayout.IAnchor getTopAnchor()

Returns the top border anchor.

Specified by:

getTopAnchor in interface IFormLayout

Returns:

the top border anchor.

getBottomAnchor

public IFormLayout.IAnchor getBottomAnchor()

Returns the bottom border anchor.

Specified by:

getBottomAnchor in interface IFormLayout

Returns:

the bottom border anchor.

getLeftMarginAnchor

public IFormLayout.IAnchor getLeftMarginAnchor()

Returns the left margin border anchor.

Specified by:

getLeftMarginAnchor in interface IFormLayout

Returns:

the left margin border anchor.

getRightMarginAnchor

public IFormLayout.IAnchor getRightMarginAnchor()

Returns the right margin border anchor.

Specified by:

getRightMarginAnchor in interface IFormLayout

Returns:

the right margin border anchor.

getTopMarginAnchor

public IFormLayout.IAnchor getTopMarginAnchor()

Returns the top margin border anchor.

Specified by:

getTopMarginAnchor in interface IFormLayout

Returns:

the top margin border anchor.

getBottomMarginAnchor

public IFormLayout.IAnchor getBottomMarginAnchor()

Returns the bottom margin border anchor.

Specified by:

getBottomMarginAnchor in interface IFormLayout

Returns:

the bottom margin border anchor.

getHorizontalAnchors

public IFormLayout.IAnchor[] getHorizontalAnchors()

Returns all horizontal anchors used by this layout.

Specified by:

getHorizontalAnchors in interface IFormLayout

Returns:

all horizontal anchors used by this layout.

getVerticalAnchors

public IFormLayout.IAnchor[] getVerticalAnchors()

Returns all vertical anchors used by this layout.

Specified by:

getVerticalAnchors in interface IFormLayout

Returns:

all vertical anchors used by this layout.

getConstraints

public IFormLayout.IConstraints getConstraints(IComponent pComponent)

Gets the constraints for the specified IComponent.

Specified by:

getConstraints in interface ILayout<IFormLayout.IConstraints>

Parameters:

pComponent - the IComponent to be queried

Returns:

the constraint for the specified IComponent, or null if component is null or is not present in this layout

setConstraints

public void setConstraints(IComponent pComponent,
                           IFormLayout.IConstraints pConstraints)

Sets the constraints for the specified IComponent.

Specified by:

setConstraints in interface ILayout<IFormLayout.IConstraints>

Parameters:

pComponent - the IComponent

pConstraints - the new constraints for the specified IComponent.

createAnchor

public IFormLayout.IAnchor createAnchor(IFormLayout.IAnchor pRelatedAnchor)

Constructs an anchor relative to pRelatedAnchor auto sized.

Specified by:

createAnchor in interface IFormLayout

Parameters:

pRelatedAnchor - the related anchor for this anchor.

Returns:

the anchor.

createAnchor

public IFormLayout.IAnchor createAnchor(IFormLayout.IAnchor pRelatedAnchor,
                                        int pPosition)

Constructs an anchor relative to pRelatedAnchor with pPosition pixels.

Specified by:

createAnchor in interface IFormLayout

Parameters:

pRelatedAnchor - the related anchor for this anchor.

pPosition - the position relative to the related anchor.

Returns:

the anchor.

getConstraints

public IFormLayout.IConstraints getConstraints(int pColumn,
                                               int pRow)

Creates the default constraints for the given column and row. Negative columns or rows counts the columns from the right or bottom border.

Specified by:

getConstraints in interface IFormLayout

Parameters:

pColumn - the column.

pRow - the row.

Returns:

the constraints for the given column and row.

getConstraints

public IFormLayout.IConstraints getConstraints(int pBeginColumn,
                                               int pBeginRow,
                                               int pEndColumn,
                                               int pEndRow)

Creates the default constraints for the given column and row.

Specified by:

getConstraints in interface IFormLayout

Parameters:

pBeginColumn - the column.

pBeginRow - the row.

pEndColumn - the column count.

pEndRow - the row count.

Returns:

the constraints for the given column and row.

getConstraints

public IFormLayout.IConstraints getConstraints(IFormLayout.IAnchor pTopAnchor,
                                               IFormLayout.IAnchor pLeftAnchor,
                                               IFormLayout.IAnchor pBottomAnchor,
                                               IFormLayout.IAnchor pRightAnchor)

Creates the default constraints for the given anchors.

Specified by:

getConstraints in interface IFormLayout

Parameters:

pTopAnchor - the top anchor.

pLeftAnchor - the left anchor.

pBottomAnchor - the bottom anchor.

pRightAnchor - the right anchor.

Returns:

the constraints for the given Anchors.

getConstraints

public IFormLayout.IConstraints getConstraints(IFormLayout.IAnchor pTopAnchor,
                                               IFormLayout.IAnchor pLeftAnchor)

Gets the constraints for the left corner, specified through anchors.

Parameters:

pTopAnchor - the top anchor

pLeftAnchor - the left anchor

Returns:

the constraints for the left corner