* Mac OS:
* Linux:
* *
By default all buttons are uniformly sized in a ButtonBar, meaning that all * buttons take the width of the widest button. It is possible to opt-out of this * on a per-button basis, but calling the {@link #setButtonUniformSize(Node, boolean)} method with * a boolean value of false. * *
If a button is excluded from uniform sizing, it is both excluded from * being resized away from its preferred size, and also excluded from the * measuring process, so its size will not influence the maximum size calculated * for all buttons in the ButtonBar. * *
Because a ButtonBar comes with built-in support for Windows, Mac OS * and Linux, there are three screenshots shown below, with the same buttons * laid out on each of the three operating systems. * *
* Windows:
* Mac OS:
* Linux:
*
*
Instantiating and using the ButtonBar is simple, simply do the following: * *
* {@code
* // Create the ButtonBar instance
* ButtonBar buttonBar = new ButtonBar();
*
* // Create the buttons to go into the ButtonBar
* Button yesButton = new Button("Yes");
* ButtonBar.setButtonData(yesButton, ButtonData.YES);
*
* Button noButton = new Button("No");
* ButtonBar.setButtonData(noButton, ButtonData.NO);
*
* // Add buttons to the ButtonBar
* buttonBar.getButtons().addAll(yesButton, noButton);
* }
*
* The code sample above will position the Yes and No buttons relative to the * users operating system. This means that on Windows and Linux the Yes button * will come before the No button, whereas on Mac OS it'll be No and then Yes. * *
In most cases the OS-specific layout is the best choice, but in cases * where you want a custom layout, this is achieved be modifying the * {@link #buttonOrderProperty() button order property}. These are cryptic-looking * strings that are shorthand representations for the button order. The built-in * orders for Windows, Mac OS and Linux are: * *
| Windows: | *L_E+U+FBXI_YNOCAH_R | *
| Mac OS: | *L_HE+U+FBIX_NCYOA_R | *
| Linux: | *L_HE+UNYACBXIO_R | *
You should refer to the {@link ButtonData} enumeration for a description of * what each of these characters mean. However, if your ButtonBar only consisted * of {@link ButtonData#YES} and {@link ButtonData#NO} buttons, you always * wanted the yes buttons before the no buttons, and you wanted the buttons to * be {@link ButtonData#BIG_GAP right-aligned}, you could do the following: * *
* {@code
* // Create the ButtonBar instance
* ButtonBar buttonBar = new ButtonBar();
*
* // Set the custom button order
* buttonBar.setButtonOrder("+YN");
* }
*
* @see ButtonData
* @since JavaFX 8u40
*/
public class ButtonBar extends Control {
// TODO add support for BUTTON_ORDER_NONE
// TODO test and document what happens with unexpected button order strings
/**************************************************************************
*
* Static fields
*
**************************************************************************/
/**
* The default button ordering on Windows.
*/
public static final String BUTTON_ORDER_WINDOWS = "L_E+U+FBXI_YNOCAH_R"; //$NON-NLS-1$
/**
* The default button ordering on Mac OS.
*/
public static final String BUTTON_ORDER_MAC_OS = "L_HE+U+FBIX_NCYOA_R"; //$NON-NLS-1$
/**
* The default button ordering on Linux (specifically, GNOME).
*/
public static final String BUTTON_ORDER_LINUX = "L_HE+UNYACBXIO_R"; //$NON-NLS-1$
/**
* A button ordering string that specifies there is no button ordering. In
* other words, buttons will be placed in the order that exist in the
* {@link #getButtons()} list. The only aspect of layout that makes this
* different than using an HBox is that the buttons are right-aligned.
*/
public static final String BUTTON_ORDER_NONE = ""; //$NON-NLS-1$
/**************************************************************************
*
* Static enumerations
*
**************************************************************************/
/**
* An enumeration of all available button data annotations. By annotating
* every button in a {@link ButtonBar} with one of these annotations, the
* buttons will be appropriately positioned relative to all other buttons in
* the ButtonBar.
*
* For details on the button order code for each ButtonData, refer to * the javadoc comment. * * @since JavaFX 8u40 */ public static enum ButtonData { /** * Buttons with this style tag will statically end up on the left end of the bar. * *
Button order code: L */ LEFT("L",false,false), //$NON-NLS-1$ /** * Buttons with this style tag will statically end up on the right end of the bar. * *
Button order code: R */ RIGHT("R", false, false), //$NON-NLS-1$ /** * A tag for the "help" button that normally is supposed to be on the right. * *
Button order code: H */ HELP("H", false, false ), //$NON-NLS-1$ /** * A tag for the "help2" button that normally is supposed to be on the left. * *
Button order code: E */ HELP_2("E", false, false), //$NON-NLS-1$ /** * A tag for the "yes" button. * *
Is default button: True *
Button order code: Y */ YES("Y", false, true), //$NON-NLS-1$ /** * A tag for the "no" button. * *
Is cancel button: True *
Button order code: N */ NO("N", true, false), //$NON-NLS-1$ /** * A tag for the "next" or "forward" button. * *
Is default button: True *
Button order code: X */ NEXT_FORWARD("X", false, true), //$NON-NLS-1$ /** * A tag for the "back" or "previous" button. * *
Button order code: B */ BACK_PREVIOUS("B", false, false), //$NON-NLS-1$ /** * A tag for the "finish". * *
Is default button: True *
Button order code: I */ FINISH("I", false, true), //$NON-NLS-1$ /** * A tag for the "apply" button. * *
Button order code: A */ APPLY("A", false, false), //$NON-NLS-1$ /** * A tag for the "cancel" or "close" button. * *
Is cancel button: True *
Button order code: C */ CANCEL_CLOSE("C", true, false), //$NON-NLS-1$ /** * A tag for the "ok" or "done" button. * *
Is default button: True *
Button order code: O */ OK_DONE("O", false, true), //$NON-NLS-1$ /** * All Uncategorized, Other, or "Unknown" buttons. Tag will be "other". * *
Button order code: U */ OTHER("U", false, false), //$NON-NLS-1$ /** * A glue push gap that will take as much space as it can and at least * an "unrelated" gap. (Platform dependent) * *
Button order code: + */ BIG_GAP("+", false, false), //$NON-NLS-1$ /** * An "unrelated" gap. (Platform dependent) * *
Button order code: _ (underscore) */ SMALL_GAP("_", false, false); //$NON-NLS-1$ private final String typeCode; private final boolean cancelButton; private final boolean defaultButton; private ButtonData(String type, boolean cancelButton, boolean defaultButton) { this.typeCode = type; this.cancelButton = cancelButton; this.defaultButton = defaultButton; } /** * Returns the single character code used to represent the ButtonData * annotation in the {@link ButtonBar#buttonOrderProperty() button order} * string. */ public String getTypeCode() { return typeCode; } /** * Indicates whether buttons created from the ButtonData enumeration * should be the 'cancel' button in the user interface. This typically * means that the button will respond to the escape key press, even if * the button does not have focus. * *
ButtonData enumeration values that can be the cancel button have a * comment stating this in their javadoc. */ public final boolean isCancelButton() { return cancelButton; } /** * Indicates whether buttons created from the ButtonData enumeration * should be the 'default' button in the user interface. This typically * means that the button will respond to enter key presses, even if the * button does not have focus. * *
ButtonData enumeration values that can be the default button have
* a comment stating this in their javadoc.
*/
public final boolean isDefaultButton() {
return defaultButton;
}
}
/**
* Sets the given ButtonData on the given button. If this button is
* subsequently placed in a {@link ButtonBar} it will be placed in the
* correct position relative to all other buttons in the bar.
*
* @param button The button to annotate with the given {@link ButtonData} value.
* @param buttonData The ButtonData to designate the button as.
*/
public static void setButtonData(Node button, ButtonData buttonData) {
final Map If a button is excluded from uniform sizing, it is both excluded from
* being resized away from its preferred size, and also excluded from the
* measuring process, so its size will not influence the maximum size calculated
* for all buttons in the ButtonBar.
*
* @param button The button to include / exclude from uniform sizing.
* @param uniformSize Boolean true to force uniform sizing on the button,
* false to exclude the button from uniform sizing.
*/
public static void setButtonUniformSize(Node button, boolean uniformSize) {
// we store the false, but remove the true (as the isButtonUniformSize
// method returns true by default)
if (uniformSize) {
button.getProperties().remove(ButtonBarSkin.BUTTON_SIZE_INDEPENDENCE);
} else {
button.getProperties().put(ButtonBarSkin.BUTTON_SIZE_INDEPENDENCE, uniformSize);
}
}
/**
* Returns whether the given node is part of the uniform sizing calculations
* or not. By default all nodes that have not opted out (via
* {@link #setButtonUniformSize(Node, boolean)}) will return true here.
*/
public static boolean isButtonUniformSize(Node button) {
return (boolean) button.getProperties().getOrDefault(ButtonBarSkin.BUTTON_SIZE_INDEPENDENCE, true);
}
/**************************************************************************
*
* Private fields
*
**************************************************************************/
private ObservableList