javax.rad.genui.layout
Class UIFormLayout

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UILayout<IFormLayout,IFormLayout.IConstraints>
          javax.rad.genui.layout.UIFormLayout

All Implemented Interfaces:

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

public class UIFormLayout
extends UILayout<IFormLayout,IFormLayout.IConstraints>
implements IFormLayout

Platform and technology independent form oriented layout. It is designed for use with AWT, Swing, SWT, JSP, JSF,... .

Nested Class Summary

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

IFormLayout.IAnchor, IFormLayout.IConstraints

Field Summary

Fields inherited from class javax.rad.genui.UIResource

uiResource

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

NEWLINE

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

UIFormLayout()
Creates a new instance of UIFormLayout.

Method Summary

IFormLayout.IAnchor	createAnchor(IFormLayout.IAnchor pRelatedAnchor) Constructs an anchor relative to pRelatedAnchor auto sized.
IFormLayout.IAnchor	createAnchor(IFormLayout.IAnchor pRelatedAnchor, IFormLayout.IAnchor pSecondRelatedAnchor) Constructs an centered anchor between the related and second related anchor.
IFormLayout.IAnchor	createAnchor(IFormLayout.IAnchor pRelatedAnchor, IFormLayout.IAnchor pSecondRelatedAnchor, float pRelativePosition) Constructs an centered anchor between the related and second related anchor.
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(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.
IFormLayout.IAnchor	getLeftAnchor() Returns the left border anchor.
IFormLayout.IAnchor	getLeftMarginAnchor() Returns the left margin border anchor.
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.
void	setHorizontalAlignment(int pHorizontalAlignment) Sets the horizontal alignment.
void	setNewlineCount(int pNewlineCount) Sets the new line count.
void	setVerticalAlignment(int pVerticalAlignment) Sets the vertical alignment.

Methods inherited from class javax.rad.genui.UILayout

getConstraints, getHorizontalGap, getMargins, getVerticalGap, setConstraints, setHorizontalGap, setMargins, setMargins, setVerticalGap

Methods inherited from class javax.rad.genui.UIResource

equals, getResource, getUIResource, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.rad.ui.ILayout

getConstraints, getHorizontalGap, getMargins, getVerticalGap, setConstraints, setHorizontalGap, setMargins, setVerticalGap

Methods inherited from interface javax.rad.ui.IResource

getResource

Constructor Detail

UIFormLayout

public UIFormLayout()

Creates a new instance of UIFormLayout.

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

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.

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.

createAnchor

public IFormLayout.IAnchor createAnchor(IFormLayout.IAnchor pRelatedAnchor,
                                        IFormLayout.IAnchor pSecondRelatedAnchor,
                                        float pRelativePosition)

Constructs an centered anchor between the related and second related anchor.

Specified by:

createAnchor in interface IFormLayout

Parameters:

pRelatedAnchor - the related anchor for this anchor.

pSecondRelatedAnchor - the second related anchor for this anchor.

pRelativePosition - the relative position between first and second anchor.

Returns:

the anchor.

createAnchor

public IFormLayout.IAnchor createAnchor(IFormLayout.IAnchor pRelatedAnchor,
                                        IFormLayout.IAnchor pSecondRelatedAnchor)

Constructs an centered anchor between the related and second related anchor.

Specified by:

createAnchor in interface IFormLayout

Parameters:

pRelatedAnchor - the related anchor for this anchor.

pSecondRelatedAnchor - the second related anchor for this 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.