com.jgoodies.forms.util.WindowsLayoutStyle Maven / Gradle / Ivy
Show all versions of forms Show documentation
/*
* Copyright (c) 2002-2008 JGoodies Karsten Lentzsch. All Rights Reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* o Neither the name of JGoodies Karsten Lentzsch nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jgoodies.forms.util;
import com.jgoodies.forms.layout.ConstantSize;
import com.jgoodies.forms.layout.Size;
import com.jgoodies.forms.layout.Sizes;
/**
* A {@link LayoutStyle} that aims to provide layout constants as defined by
* Microsoft's Design Specifications and Guidelines - Visual Design.
*
* @author Karsten Lentzsch
* @version $Revision: 1.6 $
*/
final class WindowsLayoutStyle extends LayoutStyle {
static final WindowsLayoutStyle INSTANCE = new WindowsLayoutStyle();
private WindowsLayoutStyle() {
// Suppresses default constructor, prevents instantiation.
}
// Component Sizes ******************************************************
private static final Size BUTTON_WIDTH = Sizes.dluX(50);
private static final Size BUTTON_HEIGHT = Sizes.dluY(14);
// Gaps ******************************************************************
private static final ConstantSize DIALOG_MARGIN_X = Sizes.DLUX7;
private static final ConstantSize DIALOG_MARGIN_Y = Sizes.DLUY7;
private static final ConstantSize TABBED_DIALOG_MARGIN_X = Sizes.DLUX4;
private static final ConstantSize TABBED_DIALOG_MARGIN_Y = Sizes.DLUY4;
private static final ConstantSize LABEL_COMPONENT_PADX = Sizes.DLUX3;
private static final ConstantSize RELATED_COMPONENTS_PADX = Sizes.DLUX4;
private static final ConstantSize UNRELATED_COMPONENTS_PADX = Sizes.DLUX7;
private static final ConstantSize RELATED_COMPONENTS_PADY = Sizes.DLUY4;
private static final ConstantSize UNRELATED_COMPONENTS_PADY = Sizes.DLUY7;
private static final ConstantSize NARROW_LINE_PAD = Sizes.DLUY2;
private static final ConstantSize LINE_PAD = Sizes.DLUY3;
private static final ConstantSize PARAGRAPH_PAD = Sizes.DLUY9;
private static final ConstantSize BUTTON_BAR_PAD = Sizes.DLUY5;
// Layout Sizes *********************************************************
/**
* Returns this style's default button width.
*
* @return the default button width
*
* @see #getDefaultButtonHeight()
*/
public Size getDefaultButtonWidth() {
return BUTTON_WIDTH;
}
/**
* Returns this style's default button height.
*
* @return the default button height
*
* @see #getDefaultButtonWidth()
*/
public Size getDefaultButtonHeight() {
return BUTTON_HEIGHT;
}
/**
* Returns this style's horizontal margin for general dialogs.
*
* @return the horizontal margin for general dialogs
*
* @see #getDialogMarginY()
* @see #getTabbedDialogMarginX()
*/
public ConstantSize getDialogMarginX() {
return DIALOG_MARGIN_X;
}
/**
* Returns this style's vertical margin for general dialogs.
*
* @return the vertical margin for general dialogs
*
* @see #getDialogMarginX()
* @see #getTabbedDialogMarginY()
*/
public ConstantSize getDialogMarginY() {
return DIALOG_MARGIN_Y;
}
/**
* Returns this style's horizontal margin for dialogs that consist of
* a tabbed pane.
*
* @return the horizontal margin for dialogs that consist of a tabbed pane
*
* @see #getTabbedDialogMarginY()
* @see #getDialogMarginX()
*
* @since 1.0.3
*/
public ConstantSize getTabbedDialogMarginX() {
return TABBED_DIALOG_MARGIN_X;
}
/**
* Returns this style's vertical margin for dialogs that consist of
* a tabbed pane.
*
* @return the vertical margin for dialogs that consist of a tabbed pane
*
* @see #getTabbedDialogMarginX()
* @see #getDialogMarginY()
*
* @since 1.0.3
*/
public ConstantSize getTabbedDialogMarginY() {
return TABBED_DIALOG_MARGIN_Y;
}
/**
* Returns a gap used to separate a label and associated control.
*
* @return a gap between label and associated control
*
* @see #getRelatedComponentsPadX()
* @see #getUnrelatedComponentsPadX()
*/
public ConstantSize getLabelComponentPadX() {
return LABEL_COMPONENT_PADX;
}
/**
* Returns a horizontal gap used to separate related controls.
*
* @return a horizontal gap between related controls
*
* @see #getLabelComponentPadX()
* @see #getRelatedComponentsPadY()
* @see #getUnrelatedComponentsPadX()
*/
public ConstantSize getRelatedComponentsPadX() {
return RELATED_COMPONENTS_PADX;
}
/**
* Returns a vertical gap used to separate related controls.
*
* @return a vertical gap between related controls
*
* @see #getRelatedComponentsPadX()
* @see #getUnrelatedComponentsPadY()
*/
public ConstantSize getRelatedComponentsPadY() {
return RELATED_COMPONENTS_PADY;
}
/**
* Returns a horizontal gap used to separate unrelated controls.
*
* @return a horizontal gap between unrelated controls
*
* @see #getLabelComponentPadX()
* @see #getUnrelatedComponentsPadY()
* @see #getRelatedComponentsPadX()
*/
public ConstantSize getUnrelatedComponentsPadX() {
return UNRELATED_COMPONENTS_PADX;
}
/**
* Returns a vertical gap used to separate unrelated controls.
*
* @return a vertical gap between unrelated controls
*
* @see #getUnrelatedComponentsPadX()
* @see #getRelatedComponentsPadY()
*/
public ConstantSize getUnrelatedComponentsPadY() {
return UNRELATED_COMPONENTS_PADY;
}
/**
* Returns a narrow vertical pad used to separate lines.
*
* @return a narrow vertical pad used to separate lines
*
* @see #getLinePad()
* @see #getParagraphPad()
*/
public ConstantSize getNarrowLinePad() {
return NARROW_LINE_PAD;
}
/**
* Returns a narrow vertical pad used to separate lines.
*
* @return a vertical pad used to separate lines
*
* @see #getNarrowLinePad()
* @see #getParagraphPad()
*/
public ConstantSize getLinePad() {
return LINE_PAD;
}
/**
* Returns a pad used to separate paragraphs.
*
* @return a vertical pad used to separate paragraphs
*
* @see #getNarrowLinePad()
* @see #getLinePad()
*/
public ConstantSize getParagraphPad() {
return PARAGRAPH_PAD;
}
/**
* Returns a pad used to separate a button bar from a component.
*
* @return a vertical pad used to separate paragraphs
*
* @see #getRelatedComponentsPadY()
* @see #getUnrelatedComponentsPadY()
*
* @since 1.0.3
*/
public ConstantSize getButtonBarPad() {
return BUTTON_BAR_PAD;
}
/**
* 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.
*
* @return true if buttons are typically ordered from left to right
*
* @see com.jgoodies.forms.builder.ButtonBarBuilder
* @see com.jgoodies.forms.factories.ButtonBarFactory
*
* @since 1.0.3
*/
public boolean isLeftToRightButtonOrder() {
return true;
}
}