com.jgoodies.forms.util

Class LayoutStyle

public abstract class LayoutStyle extends Object

An abstract class that describes a layout and design style guide. It provides constants used to lay out panels consistently.

This class is work in progress and the API may change without notice. Therefore it is recommended to not write custom subclasses for production code. A future version of this class will likely collaborate with a class LogicalSize or StyledSize.

Version: $Revision: 1.8 $

Author: Karsten Lentzsch

See Also: MacLayoutStyle WindowsLayoutStyle FormFactory Borders

Method Summary
abstract ConstantSizegetButtonBarPad()
Returns a pad used to separate a button bar from a component.
static LayoutStylegetCurrent()
Returns the current LayoutStyle.
abstract SizegetDefaultButtonHeight()
Returns this style's default button height.
abstract SizegetDefaultButtonWidth()
Returns this style's default button width.
abstract ConstantSizegetDialogMarginX()
Returns this style's horizontal margin for general dialogs.
abstract ConstantSizegetDialogMarginY()
Returns this style's vertical margin for general dialogs.
abstract ConstantSizegetLabelComponentPadX()
Returns a gap used to separate a label and associated control.
abstract ConstantSizegetLinePad()
Returns a narrow vertical pad used to separate lines.
abstract ConstantSizegetNarrowLinePad()
Returns a narrow vertical pad used to separate lines.
abstract ConstantSizegetParagraphPad()
Returns a pad used to separate paragraphs.
abstract ConstantSizegetRelatedComponentsPadX()
Returns a horizontal gap used to separate related controls.
abstract ConstantSizegetRelatedComponentsPadY()
Returns a vertical gap used to separate related controls.
abstract ConstantSizegetTabbedDialogMarginX()
Returns this style's horizontal margin for dialogs that consist of a tabbed pane.
abstract ConstantSizegetTabbedDialogMarginY()
Returns this style's vertical margin for dialogs that consist of a tabbed pane.
abstract ConstantSizegetUnrelatedComponentsPadX()
Returns a horizontal gap used to separate unrelated controls.
abstract ConstantSizegetUnrelatedComponentsPadY()
Returns a vertical gap used to separate unrelated controls.
abstract booleanisLeftToRightButtonOrder()
Checks and answers whether buttons are typically ordered from left to right or from right to left.
static voidsetCurrent(LayoutStyle newLayoutStyle)
Set a new LayoutStyle.

Method Detail

getButtonBarPad

public abstract ConstantSize getButtonBarPad()
Returns a pad used to separate a button bar from a component.

Returns: a vertical pad used to separate paragraphs

Since: 1.0.3

See Also: getRelatedComponentsPadY

getCurrent

public static LayoutStyle getCurrent()
Returns the current LayoutStyle.

Returns: the current LayoutStyle

getDefaultButtonHeight

public abstract Size getDefaultButtonHeight()
Returns this style's default button height.

Returns: the default button height

See Also: getDefaultButtonWidth

getDefaultButtonWidth

public abstract Size getDefaultButtonWidth()
Returns this style's default button width.

Returns: the default button width

See Also: getDefaultButtonHeight

getDialogMarginX

public abstract ConstantSize getDialogMarginX()
Returns this style's horizontal margin for general dialogs.

Returns: the horizontal margin for general dialogs

See Also: getDialogMarginY getTabbedDialogMarginX

getDialogMarginY

public abstract ConstantSize getDialogMarginY()
Returns this style's vertical margin for general dialogs.

Returns: the vertical margin for general dialogs

See Also: getDialogMarginX getTabbedDialogMarginY

getLabelComponentPadX

public abstract ConstantSize getLabelComponentPadX()
Returns a gap used to separate a label and associated control.

Returns: a gap between label and associated control

See Also: getRelatedComponentsPadX getUnrelatedComponentsPadX

getLinePad

public abstract ConstantSize getLinePad()
Returns a narrow vertical pad used to separate lines.

Returns: a vertical pad used to separate lines

See Also: getNarrowLinePad getParagraphPad

getNarrowLinePad

public abstract ConstantSize getNarrowLinePad()
Returns a narrow vertical pad used to separate lines.

Returns: a narrow vertical pad used to separate lines

See Also: getLinePad getParagraphPad

getParagraphPad

public abstract ConstantSize getParagraphPad()
Returns a pad used to separate paragraphs.

Returns: a vertical pad used to separate paragraphs

See Also: getNarrowLinePad getLinePad

getRelatedComponentsPadX

public abstract ConstantSize getRelatedComponentsPadX()
Returns a horizontal gap used to separate related controls.

Returns: a horizontal gap between related controls

See Also: getLabelComponentPadX getRelatedComponentsPadY getUnrelatedComponentsPadX

getRelatedComponentsPadY

public abstract ConstantSize getRelatedComponentsPadY()
Returns a vertical gap used to separate related controls.

Returns: a vertical gap between related controls

See Also: getRelatedComponentsPadX getUnrelatedComponentsPadY

getTabbedDialogMarginX

public abstract ConstantSize getTabbedDialogMarginX()
Returns this style's horizontal margin for dialogs that consist of a tabbed pane.

Returns: the horizontal margin for dialogs that consist of a tabbed pane

Since: 1.0.3

See Also: getTabbedDialogMarginY

getTabbedDialogMarginY

public abstract ConstantSize getTabbedDialogMarginY()
Returns this style's vertical margin for dialogs that consist of a tabbed pane.

Returns: the vertical margin for dialogs that consist of a tabbed pane

Since: 1.0.3

See Also: getTabbedDialogMarginX

getUnrelatedComponentsPadX

public abstract ConstantSize getUnrelatedComponentsPadX()
Returns a horizontal gap used to separate unrelated controls.

Returns: a horizontal gap between unrelated controls

See Also: getLabelComponentPadX getUnrelatedComponentsPadY getRelatedComponentsPadX

getUnrelatedComponentsPadY

public abstract ConstantSize getUnrelatedComponentsPadY()
Returns a vertical gap used to separate unrelated controls.

Returns: a vertical gap between unrelated controls

See Also: getUnrelatedComponentsPadX getRelatedComponentsPadY

isLeftToRightButtonOrder

public abstract boolean isLeftToRightButtonOrder()
Checks and answers whether buttons are typically ordered from left to right or from right to left. Useful for building button bars that shall comply with the platform's layout style guide.

For example the Windows style guide recommends to layout out OK, Cancel, Apply from left to right, where the Mac Aqua style guide recommends to layout out these buttons from right to left.

Although most button sequences shall honor this order some buttons require a left to right order. For example Back, Next or Move Left, Move Right.

Returns: true if buttons are typically ordered from left to right

Since: 1.0.3

See Also: ButtonBarBuilder

setCurrent

public static void setCurrent(LayoutStyle newLayoutStyle)
Set a new LayoutStyle.

Parameters: newLayoutStyle the style to be set

Copyright © 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.