Client Properties

Specifies type of a button.

Allowed Values:

• "square" - Paint the button with square edges (JButton and JToggleButton).
• "roundRect" - Paint the button with round edges (JButton and JToggleButton).
• "tab" - Paint the toggle button in tab style (JToggleButton).
• "help" - Paint a help button (circle with question mark) (JButton).

• "toolBarButton" - Paint the button in toolbar style (JButton and JToggleButton).

String

Specifies selected state of a checkbox.

Allowed Values:

• "indeterminate" - Paint an indeterminate state on a checkbox.

String

Specifies the outline color of the component border.

Allowed Values:

• "error" - Paint the component border in another color (usually reddish) to indicate an error.
• "warning" - Paint the component border in another color (usually yellowish) to indicate a warning.
• any color (type Color)

• an array of two colors (type Color[2]) where the first color is for focused state and the second for unfocused state

String or Color or Color[2]

Use a java.util.function.Predicate that receives the component as parameter:

myComponent.putClientProperty( "JComponent.focusOwner",
    (Predicate<JComponent>) c -> {
        return ...; // check here
    } );

Either use a java.util.function.IntConsumer that receives the tab index as parameter:

myTabbedPane.putClientProperty( "JTabbedPane.tabCloseCallback",
    (IntConsumer) tabIndex -> {
        // close tab here
    } );

Or use a java.util.function.BiConsumer<JTabbedPane, Integer> that receives the tabbed pane and the tab index as parameters:

myTabbedPane.putClientProperty( "JTabbedPane.tabCloseCallback",
    (BiConsumer<JTabbedPane, Integer>) (tabbedPane, tabIndex) -> {
        // close tab here
    } );

If you need to check whether a modifier key (e.g. Alt or Shift) was pressed while the user clicked the tab close button, use EventQueue.getCurrentEvent() to get current event, check whether it is a MouseEvent and invoke its methods. E.g.

AWTEvent e = EventQueue.getCurrentEvent();
boolean shift = (e instanceof MouseEvent) ? ((MouseEvent)e).isShiftDown() : false;

Specifies the display policy for the "more tabs" button, which shows a popup menu with the (partly) hidden tabs.

Allowed Values:

• "never" - Display never.

• "asNeeded" - Display only when needed.

String

Specifies the display policy for the forward/backward scroll arrow buttons.

Allowed Values:

• "never" - Display never.
• "asNeeded" - Display only when needed. Both scroll arrow buttons are either shown or hidden. Buttons are disabled if scrolling in that direction is not applicable.

• "asNeededSingle" - Display single button only when needed. If scroll button placement is trailing, then this option is ignored and both buttons are shown or hidden as needed.

String

Specifies the placement of the forward/backward scroll arrow buttons.

Allowed Values:

• "both" - The forward/backward scroll arrow buttons are placed on both sides of the tab area. The backward scroll button at the left/top side. The forward scroll button at the right/bottom side.

• "trailing" - The forward/backward scroll arrow buttons are placed on the trailing side of the tab area.

String

Specifies the alignment of the tab area.

Allowed Values:

• SwingConstants.LEADING or "leading" - Align to the leading edge. (default)
• SwingConstants.TRAILING or "trailing" - Align to the trailing edge.
• SwingConstants.CENTER or "center" - Align to center.

• "fill" - Stretch to fill all available space.

Integer or String

Specifies the horizontal alignment of the tab title and icon.

Allowed Values:

• SwingConstants.LEADING or "leading" - Align to the leading edge.
• SwingConstants.TRAILING or "trailing" - Align to the trailing edge.

• SwingConstants.CENTER or "center" - Align to center. (default)

Integer or String

Specifies how the tabs should be sized.

Allowed Values:

• "preferred" - Tab width is adjusted to tab icon and title. (default)
• "equal" - All tabs in a tabbed pane has same width.

• "compact" - Unselected tabs are smaller because they show only the tab icon, but no tab title. Selected tabs show both.

String

Specifies the tab icon placement (relative to tab title).

Allowed Values:

• SwingConstants.LEADING - Place icon left to title. (default)
• SwingConstants.TRAILING - Place icon right to title.
• SwingConstants.TOP - Place icon above title.

• SwingConstants.BOTTOM - Place icon below title.

Integer

Specifies whether all text is selected when the text component gains focus.

Allowed Values:

• "never" - Never select all text when the text component gains focus.
• "once" - Select all text when the text component gains focus for the first time and selection was not modified (is at end of text). This is the default.

• "always" - Always select all text when the text component gains focus.

String