Interface FlatClientProperties
-
public interface FlatClientPropertiesDefines/documents own client properties used in FlatLaf.
-
-
Field Summary
Fields Modifier and Type Field Description static StringBUTTON_TYPESpecifies type of a button.static StringBUTTON_TYPE_BORDERLESSPaint the button without a border in the unfocused state.static StringBUTTON_TYPE_HELPPaint a help button (circle with question mark).static StringBUTTON_TYPE_ROUND_RECTPaint the button with round edges.static StringBUTTON_TYPE_SQUAREPaint the button with square edges.static StringBUTTON_TYPE_TABPaint the toggle button in tab style.static StringBUTTON_TYPE_TOOLBAR_BUTTONPaint the button in toolbar style.static StringCOMPONENT_FOCUS_OWNERSpecifies a callback that is invoked to check whether a component is permanent focus owner.static StringCOMPONENT_ROUND_RECTPaint the component with round edges.static StringCOMPONENT_TITLE_BAR_CAPTIONSpecifies whether a component in an embedded menu bar should behave as caption (left-click allows moving window, right-click shows window system menu).static StringMENU_BAR_EMBEDDEDSpecifies whether the menu bar is embedded into the window title pane if window decorations are enabled.static StringMINIMUM_HEIGHTSpecifies minimum height of a component.static StringMINIMUM_WIDTHSpecifies minimum width of a component.static StringOUTLINESpecifies the outline color of the component border.static StringOUTLINE_ERRORPaint the component border in another color (usually reddish) to indicate an error.static StringOUTLINE_WARNINGPaint the component border in another color (usually yellowish) to indicate a warning.static StringPLACEHOLDER_TEXTPlaceholder text that is only painted if the text field is empty.static StringPOPUP_DROP_SHADOW_PAINTEDSpecifies whether a drop shadow is painted if the component is shown in a popup or if the component is the owner of another component that is shown in a popup.static StringPOPUP_FORCE_HEAVY_WEIGHTSpecifies whether a heavy weight window should be used if the component is shown in a popup or if the component is the owner of another component that is shown in a popup.static StringPROGRESS_BAR_LARGE_HEIGHTSpecifies whether the progress bar has always the larger height even if no string is painted.static StringPROGRESS_BAR_SQUARESpecifies whether the progress bar is paint with square edges.static StringSCROLL_BAR_SHOW_BUTTONSSpecifies whether the decrease/increase arrow buttons of a scrollbar are shown.static StringSCROLL_PANE_SMOOTH_SCROLLINGSpecifies whether the scroll pane uses smooth scrolling.static StringSELECT_ALL_ON_FOCUS_POLICYSpecifies whether all text is selected when the text component gains focus.static StringSELECT_ALL_ON_FOCUS_POLICY_ALWAYSAlways select all text when the text component gains focus.static StringSELECT_ALL_ON_FOCUS_POLICY_NEVERNever select all text when the text component gains focus.static StringSELECT_ALL_ON_FOCUS_POLICY_ONCESelect all text when the text component gains focus for the first time and selection was not modified (is at end of text).static StringSELECTED_STATESpecifies selected state of a checkbox.static StringSELECTED_STATE_INDETERMINATEPaint an indeterminate state on a checkbox.static StringSPLIT_PANE_EXPANDABLE_SIDESpecifies what side of the spilt pane is allowed to expand via one-touch expanding arrow buttons.static StringSPLIT_PANE_EXPANDABLE_SIDE_LEFTAllow expanding only left/top side of the split pane.static StringSPLIT_PANE_EXPANDABLE_SIDE_RIGHTAllow expanding only right/bottom side of the split pane.static StringSQUARE_SIZESpecifies whether the button preferred size will be made square (quadratically).static StringSTYLESpecifies the style of a component as String in CSS syntax ("key1: value1; key2: value2; ...") or asMap<String, Object> with binary values.static StringSTYLE_CLASSSpecifies the style class(es) of a component as String (single class or multiple classes separated by space characters) or asString[]orList<String> (multiple classes).static StringTAB_BUTTON_SELECTED_BACKGROUNDBackground color if selected and toggle button type isBUTTON_TYPE_TAB.static StringTAB_BUTTON_UNDERLINE_COLORColor of underline if toggle button type isBUTTON_TYPE_TAB.static StringTAB_BUTTON_UNDERLINE_HEIGHTThickness of underline if toggle button type isBUTTON_TYPE_TAB.static StringTAB_BUTTON_UNDERLINE_PLACEMENTPlacement of underline if toggle button type isBUTTON_TYPE_TABstatic StringTABBED_PANE_ALIGN_CENTERAlign to center.static StringTABBED_PANE_ALIGN_FILLStretch to fill all available space.static StringTABBED_PANE_ALIGN_LEADINGAlign to the leading edge.static StringTABBED_PANE_ALIGN_TRAILINGAlign to the trailing edge.static StringTABBED_PANE_HAS_FULL_BORDERSpecifies whether a full border is painted around a tabbed pane.static StringTABBED_PANE_HIDE_TAB_AREA_WITH_ONE_TABSpecifies whether the tab area should be hidden if it contains only one tab.static StringTABBED_PANE_LEADING_COMPONENTSpecifies a component that will be placed at the leading edge of the tabs area.static StringTABBED_PANE_MAXIMUM_TAB_WIDTHSpecifies the maximum width of a tab.static StringTABBED_PANE_MINIMUM_TAB_WIDTHSpecifies the minimum width of a tab.static StringTABBED_PANE_PLACEMENT_BOTHThe forward/backward scroll arrow buttons are placed on both sides of the tab area.static StringTABBED_PANE_PLACEMENT_TRAILINGThe forward/backward scroll arrow buttons are placed on the trailing side of the tab area.static StringTABBED_PANE_POLICY_AS_NEEDEDDisplay only when needed.static StringTABBED_PANE_POLICY_AS_NEEDED_SINGLEDisplay single button only when needed.static StringTABBED_PANE_POLICY_NEVERDisplay never.static StringTABBED_PANE_SCROLL_BUTTONS_PLACEMENTSpecifies the placement of the forward/backward scroll arrow buttons.static StringTABBED_PANE_SCROLL_BUTTONS_POLICYSpecifies the display policy for the forward/backward scroll arrow buttons.static StringTABBED_PANE_SHOW_CONTENT_SEPARATORSpecifies whether the separator between tabs area and content area should be shown.static StringTABBED_PANE_SHOW_TAB_SEPARATORSSpecifies whether separators are shown between tabs.static StringTABBED_PANE_TAB_ALIGNMENTSpecifies the horizontal alignment of the tab title and icon.static StringTABBED_PANE_TAB_AREA_ALIGNMENTSpecifies the alignment of the tab area.static StringTABBED_PANE_TAB_AREA_INSETSSpecifies the insets of the tab area.static StringTABBED_PANE_TAB_CLOSABLESpecifies whether tabs are closable.static StringTABBED_PANE_TAB_CLOSE_CALLBACKSpecifies the callback that is invoked when a tab close button is clicked.static StringTABBED_PANE_TAB_CLOSE_TOOLTIPTEXTSpecifies the tooltip text used for tab close buttons.static StringTABBED_PANE_TAB_HEIGHTSpecifies the minimum height of a tab.static StringTABBED_PANE_TAB_ICON_PLACEMENTSpecifies the tab icon placement (relative to tab title).static StringTABBED_PANE_TAB_INSETSSpecifies the insets of a tab.static StringTABBED_PANE_TAB_TYPESpecifies type of the selected tab.static StringTABBED_PANE_TAB_TYPE_CARDPaint the selected tab as card.static StringTABBED_PANE_TAB_TYPE_UNDERLINEDPaint the selected tab underlined.static StringTABBED_PANE_TAB_WIDTH_MODESpecifies how the tabs should be sized.static StringTABBED_PANE_TAB_WIDTH_MODE_COMPACTUnselected tabs are smaller because they show only the tab icon, but no tab title.static StringTABBED_PANE_TAB_WIDTH_MODE_EQUALAll tabs in a tabbed pane has same width.static StringTABBED_PANE_TAB_WIDTH_MODE_PREFERREDTab width is adjusted to tab icon and title.static StringTABBED_PANE_TABS_POPUP_POLICYSpecifies the display policy for the "more tabs" button, which shows a popup menu with the (partly) hidden tabs.static StringTABBED_PANE_TRAILING_COMPONENTSpecifies a component that will be placed at the trailing edge of the tabs area.static StringTEXT_FIELD_CLEAR_CALLBACKSpecifies the callback that is invoked when a "clear" (or "cancel") button is clicked.static StringTEXT_FIELD_LEADING_COMPONENTSpecifies a component that will be placed at the leading edge of the text field.static StringTEXT_FIELD_LEADING_ICONSpecifies an icon that will be placed at the leading edge of the text field.static StringTEXT_FIELD_PADDINGSpecifies the padding of the text.static StringTEXT_FIELD_SHOW_CLEAR_BUTTONSpecifies whether a "clear" (or "cancel") button is shown on the trailing side if the text field is not empty, editable and enabled.static StringTEXT_FIELD_TRAILING_COMPONENTSpecifies a component that will be placed at the trailing edge of the text field.static StringTEXT_FIELD_TRAILING_ICONSpecifies an icon that will be placed at the trailing edge of the text field.static StringTITLE_BAR_BACKGROUNDBackground color of window title bar (requires enabled window decorations).static StringTITLE_BAR_FOREGROUNDForeground color of window title bar (requires enabled window decorations).static StringTITLE_BAR_SHOW_CLOSESpecifies whether the "close" button should be shown in the window title bar (requires enabled window decorations).static StringTITLE_BAR_SHOW_ICONSpecifies whether the window icon should be shown in the window title bar (requires enabled window decorations).static StringTITLE_BAR_SHOW_ICONIFFYSpecifies whether the "iconfify" button should be shown in the window title bar (requires enabled window decorations).static StringTITLE_BAR_SHOW_MAXIMIZESpecifies whether the "maximize/restore" button should be shown in the window title bar (requires enabled window decorations).static StringTITLE_BAR_SHOW_TITLESpecifies whether the window title should be shown in the window title bar (requires enabled window decorations).static StringTREE_PAINT_SELECTIONSpecifies whether tree item selection is painted.static StringTREE_WIDE_SELECTIONOverride if a tree shows a wide selection.static StringUSE_WINDOW_DECORATIONSSpecifies whether FlatLaf native window decorations should be used forJFrameorJDialog.
-
Method Summary
Static Methods Modifier and Type Method Description static <T> TclientProperty(JComponent c, String key, T defaultValue, Class<T> type)Returns the value of the specified client property if it is an instance of the specified type.static booleanclientPropertyBoolean(JComponent c, String key, boolean defaultValue)Checks whether a client property of a component is a boolean and returns its value.static BooleanclientPropertyBooleanStrict(JComponent c, String key, Boolean defaultValue)Checks whether a client property of a component is aBooleanand returns its value.static ColorclientPropertyColor(JComponent c, String key, Color defaultValue)Checks whether a client property of a component is a color and returns its value.static booleanclientPropertyEquals(JComponent c, String key, Object value)Checks whether a client property of a component has the given value.static intclientPropertyInt(JComponent c, String key, int defaultValue)Checks whether a client property of a component is an integer and returns its value.
-
-
-
Field Detail
-
BUTTON_TYPE
static final String BUTTON_TYPE
Specifies type of a button.Components
JButtonandJToggleButton
Value typeString
Allowed ValuesBUTTON_TYPE_SQUARE,BUTTON_TYPE_ROUND_RECT,BUTTON_TYPE_TAB,BUTTON_TYPE_HELP,BUTTON_TYPE_TOOLBAR_BUTTONorBUTTON_TYPE_BORDERLESS- See Also:
- Constant Field Values
-
BUTTON_TYPE_SQUARE
static final String BUTTON_TYPE_SQUARE
Paint the button with square edges.Components
JButtonandJToggleButton- See Also:
BUTTON_TYPE, Constant Field Values
-
BUTTON_TYPE_ROUND_RECT
static final String BUTTON_TYPE_ROUND_RECT
Paint the button with round edges.Components
JButtonandJToggleButton- See Also:
BUTTON_TYPE, Constant Field Values
-
BUTTON_TYPE_TAB
static final String BUTTON_TYPE_TAB
Paint the toggle button in tab style.Components
JToggleButton- See Also:
BUTTON_TYPE, Constant Field Values
-
BUTTON_TYPE_HELP
static final String BUTTON_TYPE_HELP
Paint a help button (circle with question mark).Components
JButton- See Also:
BUTTON_TYPE, Constant Field Values
-
BUTTON_TYPE_TOOLBAR_BUTTON
static final String BUTTON_TYPE_TOOLBAR_BUTTON
Paint the button in toolbar style.Components
JButtonandJToggleButton- See Also:
BUTTON_TYPE, Constant Field Values
-
BUTTON_TYPE_BORDERLESS
static final String BUTTON_TYPE_BORDERLESS
Paint the button without a border in the unfocused state.Components
JButtonandJToggleButton- Since:
- 1.2
- See Also:
BUTTON_TYPE, Constant Field Values
-
SELECTED_STATE
static final String SELECTED_STATE
Specifies selected state of a checkbox.Component
JCheckBox
Value typeString
Allowed ValuesSELECTED_STATE_INDETERMINATE- See Also:
- Constant Field Values
-
SELECTED_STATE_INDETERMINATE
static final String SELECTED_STATE_INDETERMINATE
Paint an indeterminate state on a checkbox.- See Also:
SELECTED_STATE, Constant Field Values
-
SQUARE_SIZE
static final String SQUARE_SIZE
Specifies whether the button preferred size will be made square (quadratically).Components
JButtonandJToggleButton
Value typeBoolean- See Also:
- Constant Field Values
-
STYLE
static final String STYLE
Specifies the style of a component as String in CSS syntax ("key1: value1; key2: value2; ...") or asMap<String, Object> with binary values.The keys are the same as used in UI defaults, but without component type prefix. E.g. for UI default
Slider.thumbSizeuse keythumbSize.The syntax of the CSS values is the same as used in FlatLaf properties files (https://www.formdev.com/flatlaf/properties-files/), but some features are not supported (e.g. variables). When using a map, the values are not parsed from a string. They must be binary.
Components
JComponent
Value typeStringorMap<String, Object>- Since:
- 2
- See Also:
- Constant Field Values
-
STYLE_CLASS
static final String STYLE_CLASS
Specifies the style class(es) of a component as String (single class or multiple classes separated by space characters) or asString[]orList<String> (multiple classes).The style rules must be defined in UI defaults either as strings (in CSS syntax) or as
Map<String, Object> (with binary values). The key must be in syntax:[style]type.styleClass, where the type is optional. E.g. in FlatLaf properties file:
or in Java code:[style]Button.primary = borderColor: #08f; background: #08f; foreground: #fff [style].secondary = borderColor: #0f8; background: #0f8
The rule "Button.primary" can be applied to buttons only. The rule ".secondary" can be applied to any component.UIManager.put( "[style]Button.primary", "borderColor: #08f; background: #08f; foreground: #fff" ); UIManager.put( "[style].secondary", "borderColor: #0f8; background: #0f8" );To have similar behavior as in CSS, first the rule without type is applied, then the rule with type. E.g. setting style class to "foo" on a
JButtonuses rules from UI default keys "[style].foo" and "[style]Button.foo".Components
JComponent
Value typeString,String[]orList<String>- Since:
- 2
- See Also:
- Constant Field Values
-
MINIMUM_WIDTH
static final String MINIMUM_WIDTH
Specifies minimum width of a component.Component
JButton,JToggleButton,JComboBox,JSpinnerandJTextComponent
Value typeInteger- See Also:
- Constant Field Values
-
MINIMUM_HEIGHT
static final String MINIMUM_HEIGHT
Specifies minimum height of a component.Component
JButtonandJToggleButton
Value typeInteger- See Also:
- Constant Field Values
-
COMPONENT_ROUND_RECT
static final String COMPONENT_ROUND_RECT
Paint the component with round edges.Components
JComboBox,JSpinner,JTextField,JFormattedTextFieldandJPasswordField
Value typeBoolean- See Also:
- Constant Field Values
-
OUTLINE
static final String OUTLINE
Specifies the outline color of the component border.Components
JButton,JComboBox,JFormattedTextField,JPasswordField,JScrollPane,JSpinner,JTextFieldandJToggleButton
Value typeStringorColororColor[2]
Allowed ValuesOUTLINE_ERROR,OUTLINE_WARNING, any color (typeColor) or an array of two colors (typeColor[2]) where the first color is for focused state and the second for unfocused state- See Also:
- Constant Field Values
-
OUTLINE_ERROR
static final String OUTLINE_ERROR
Paint the component border in another color (usually reddish) to indicate an error.- See Also:
OUTLINE, Constant Field Values
-
OUTLINE_WARNING
static final String OUTLINE_WARNING
Paint the component border in another color (usually yellowish) to indicate a warning.- See Also:
OUTLINE, Constant Field Values
-
COMPONENT_FOCUS_OWNER
static final String COMPONENT_FOCUS_OWNER
Specifies a callback that is invoked to check whether a component is permanent focus owner. Used to paint focus indicators.May be useful in special cases for custom components.
Use a
Predicatethat receives the component as parameter:myComponent.putClientProperty( "JComponent.focusOwner", (Predicate<JComponent>) c -> { return ...; // check here } );Component
JComponent
Value typePredicate<javax.swing.JComponent>- See Also:
- Constant Field Values
-
COMPONENT_TITLE_BAR_CAPTION
static final String COMPONENT_TITLE_BAR_CAPTION
Specifies whether a component in an embedded menu bar should behave as caption (left-click allows moving window, right-click shows window system menu). The component does not receive mouse pressed/released/clicked/dragged events, but it gets mouse entered/exited/moved events.Component
JComponent
Value typeBoolean- Since:
- 2.5
- See Also:
- Constant Field Values
-
POPUP_DROP_SHADOW_PAINTED
static final String POPUP_DROP_SHADOW_PAINTED
Specifies whether a drop shadow is painted if the component is shown in a popup or if the component is the owner of another component that is shown in a popup.Component
JComponent
Value typeBoolean- See Also:
- Constant Field Values
-
POPUP_FORCE_HEAVY_WEIGHT
static final String POPUP_FORCE_HEAVY_WEIGHT
Specifies whether a heavy weight window should be used if the component is shown in a popup or if the component is the owner of another component that is shown in a popup.Component
JComponent
Value typeBoolean- See Also:
- Constant Field Values
-
PROGRESS_BAR_LARGE_HEIGHT
static final String PROGRESS_BAR_LARGE_HEIGHT
Specifies whether the progress bar has always the larger height even if no string is painted.Component
JProgressBar
Value typeBoolean- See Also:
- Constant Field Values
-
PROGRESS_BAR_SQUARE
static final String PROGRESS_BAR_SQUARE
Specifies whether the progress bar is paint with square edges.Component
JProgressBar
Value typeBoolean- See Also:
- Constant Field Values
-
USE_WINDOW_DECORATIONS
static final String USE_WINDOW_DECORATIONS
Specifies whether FlatLaf native window decorations should be used forJFrameorJDialog.Setting this enables/disables using FlatLaf native window decorations for the window that contains the root pane.
This client property has lower priority than system property
FlatSystemProperties.USE_WINDOW_DECORATIONS, but higher priority than UI defaultTitlePane.useWindowDecorations.(requires Window 10)
- Since:
- 1.1.1
- See Also:
- Constant Field Values
-
MENU_BAR_EMBEDDED
static final String MENU_BAR_EMBEDDED
Specifies whether the menu bar is embedded into the window title pane if window decorations are enabled.Setting this enables/disables embedding for the window that contains the root pane.
This client property has lower priority than system property
FlatSystemProperties.MENUBAR_EMBEDDED, but higher priority than UI defaultTitlePane.menuBarEmbedded.(requires Window 10)
- See Also:
- Constant Field Values
-
TITLE_BAR_SHOW_ICON
static final String TITLE_BAR_SHOW_ICON
Specifies whether the window icon should be shown in the window title bar (requires enabled window decorations). Default is UI propertyTitlePane.showIcon.Setting this shows/hides the windows icon for the
JFrameorJDialogthat contains the root pane.This client property has higher priority than UI default
TitlePane.showIcon.(requires Window 10)
- Since:
- 2
- See Also:
- Constant Field Values
-
TITLE_BAR_SHOW_TITLE
static final String TITLE_BAR_SHOW_TITLE
Specifies whether the window title should be shown in the window title bar (requires enabled window decorations). Default istrue.Setting this shows/hides the windows title for the
JFrameorJDialogthat contains the root pane.- Since:
- 3
- See Also:
- Constant Field Values
-
TITLE_BAR_SHOW_ICONIFFY
static final String TITLE_BAR_SHOW_ICONIFFY
Specifies whether the "iconfify" button should be shown in the window title bar (requires enabled window decorations). Default istrue.Setting this shows/hides the "iconfify" button for the
JFramethat contains the root pane.- Since:
- 3
- See Also:
- Constant Field Values
-
TITLE_BAR_SHOW_MAXIMIZE
static final String TITLE_BAR_SHOW_MAXIMIZE
Specifies whether the "maximize/restore" button should be shown in the window title bar (requires enabled window decorations). Default istrue.Setting this shows/hides the "maximize/restore" button for the
JFramethat contains the root pane.- Since:
- 3
- See Also:
- Constant Field Values
-
TITLE_BAR_SHOW_CLOSE
static final String TITLE_BAR_SHOW_CLOSE
Specifies whether the "close" button should be shown in the window title bar (requires enabled window decorations). Default istrue.Setting this shows/hides the "close" button for the
JFrameorJDialogthat contains the root pane.- Since:
- 3
- See Also:
- Constant Field Values
-
TITLE_BAR_BACKGROUND
static final String TITLE_BAR_BACKGROUND
Background color of window title bar (requires enabled window decorations).(requires Window 10)
- Since:
- 1.1.2
- See Also:
- Constant Field Values
-
TITLE_BAR_FOREGROUND
static final String TITLE_BAR_FOREGROUND
Foreground color of window title bar (requires enabled window decorations).(requires Window 10)
- Since:
- 1.1.2
- See Also:
- Constant Field Values
-
SCROLL_BAR_SHOW_BUTTONS
static final String SCROLL_BAR_SHOW_BUTTONS
Specifies whether the decrease/increase arrow buttons of a scrollbar are shown.Component
JScrollBarorJScrollPane
Value typeBoolean- See Also:
- Constant Field Values
-
SCROLL_PANE_SMOOTH_SCROLLING
static final String SCROLL_PANE_SMOOTH_SCROLLING
Specifies whether the scroll pane uses smooth scrolling.Component
JScrollPane
Value typeBoolean- See Also:
- Constant Field Values
-
SPLIT_PANE_EXPANDABLE_SIDE
static final String SPLIT_PANE_EXPANDABLE_SIDE
Specifies what side of the spilt pane is allowed to expand via one-touch expanding arrow buttons. Requires that one-touch expanding is enabled withJSplitPane.setOneTouchExpandable(boolean).Component
JSplitPane
Value typeString
Allowed ValuesSPLIT_PANE_EXPANDABLE_SIDE_LEFTorSPLIT_PANE_EXPANDABLE_SIDE_RIGHT- Since:
- 2.2
- See Also:
- Constant Field Values
-
SPLIT_PANE_EXPANDABLE_SIDE_LEFT
static final String SPLIT_PANE_EXPANDABLE_SIDE_LEFT
Allow expanding only left/top side of the split pane.- Since:
- 2.2
- See Also:
SPLIT_PANE_EXPANDABLE_SIDE, Constant Field Values
-
SPLIT_PANE_EXPANDABLE_SIDE_RIGHT
static final String SPLIT_PANE_EXPANDABLE_SIDE_RIGHT
Allow expanding only right/bottom side of the split pane.- Since:
- 2.2
- See Also:
SPLIT_PANE_EXPANDABLE_SIDE, Constant Field Values
-
TABBED_PANE_TAB_TYPE
static final String TABBED_PANE_TAB_TYPE
Specifies type of the selected tab.Component
JTabbedPane
Value typeString
Allowed ValuesTABBED_PANE_TAB_TYPE_UNDERLINEDorTABBED_PANE_TAB_TYPE_CARD- Since:
- 2
- See Also:
- Constant Field Values
-
TABBED_PANE_TAB_TYPE_UNDERLINED
static final String TABBED_PANE_TAB_TYPE_UNDERLINED
Paint the selected tab underlined.- Since:
- 2
- See Also:
TABBED_PANE_TAB_TYPE, Constant Field Values
-
TABBED_PANE_TAB_TYPE_CARD
static final String TABBED_PANE_TAB_TYPE_CARD
Paint the selected tab as card.- Since:
- 2
- See Also:
TABBED_PANE_TAB_TYPE, Constant Field Values
-
TABBED_PANE_SHOW_TAB_SEPARATORS
static final String TABBED_PANE_SHOW_TAB_SEPARATORS
Specifies whether separators are shown between tabs.Component
JTabbedPane
Value typeBoolean- See Also:
- Constant Field Values
-
TABBED_PANE_SHOW_CONTENT_SEPARATOR
static final String TABBED_PANE_SHOW_CONTENT_SEPARATOR
Specifies whether the separator between tabs area and content area should be shown.Component
JTabbedPane
Value typeBoolean- See Also:
- Constant Field Values
-
TABBED_PANE_HAS_FULL_BORDER
static final String TABBED_PANE_HAS_FULL_BORDER
Specifies whether a full border is painted around a tabbed pane.Component
JTabbedPane
Value typeBoolean- See Also:
- Constant Field Values
-
TABBED_PANE_HIDE_TAB_AREA_WITH_ONE_TAB
static final String TABBED_PANE_HIDE_TAB_AREA_WITH_ONE_TAB
Specifies whether the tab area should be hidden if it contains only one tab.Component
JTabbedPane
Value typeBoolean- See Also:
- Constant Field Values
-
TABBED_PANE_MINIMUM_TAB_WIDTH
static final String TABBED_PANE_MINIMUM_TAB_WIDTH
Specifies the minimum width of a tab.Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeInteger- See Also:
- Constant Field Values
-
TABBED_PANE_MAXIMUM_TAB_WIDTH
static final String TABBED_PANE_MAXIMUM_TAB_WIDTH
Specifies the maximum width of a tab.Applied only if tab does not have a custom tab component (see
JTabbedPane.setTabComponentAt(int, java.awt.Component)).Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeInteger- See Also:
- Constant Field Values
-
TABBED_PANE_TAB_HEIGHT
static final String TABBED_PANE_TAB_HEIGHT
Specifies the minimum height of a tab.Component
JTabbedPane
Value typeInteger- See Also:
TABBED_PANE_TAB_INSETS, Constant Field Values
-
TABBED_PANE_TAB_INSETS
static final String TABBED_PANE_TAB_INSETS
Specifies the insets of a tab.Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeInsets- See Also:
TABBED_PANE_TAB_HEIGHT, Constant Field Values
-
TABBED_PANE_TAB_AREA_INSETS
static final String TABBED_PANE_TAB_AREA_INSETS
Specifies the insets of the tab area.Component
JTabbedPane
Value typeInsets- See Also:
- Constant Field Values
-
TABBED_PANE_TAB_CLOSABLE
static final String TABBED_PANE_TAB_CLOSABLE
Specifies whether tabs are closable. If set totrueon a tabbed pane component, all tabs in that tabbed pane are closable. To make individual tabs closable, set it totrueon a tab content component.Note that you have to specify a callback (see
TABBED_PANE_TAB_CLOSABLE) that is invoked when the user clicks a tab close button. The callback is responsible for closing the tab.Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeBoolean
-
TABBED_PANE_TAB_CLOSE_TOOLTIPTEXT
static final String TABBED_PANE_TAB_CLOSE_TOOLTIPTEXT
Specifies the tooltip text used for tab close buttons.Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeString- See Also:
TABBED_PANE_TAB_CLOSABLE, Constant Field Values
-
TABBED_PANE_TAB_CLOSE_CALLBACK
static final String TABBED_PANE_TAB_CLOSE_CALLBACK
Specifies the callback that is invoked when a tab close button is clicked. The callback is responsible for closing the tab.Either use a
IntConsumerthat receives the tab index as parameter:
Or use amyTabbedPane.putClientProperty( "JTabbedPane.tabCloseCallback", (IntConsumer) tabIndex -> { // close tab here } );BiConsumer<javax.swing.JTabbedPane, Integer> that receives the tabbed pane and the tab index as parameters:
If you need to check whether a modifier key (e.g. Alt or Shift) was pressed while the user clicked the tab close button, usemyTabbedPane.putClientProperty( "JTabbedPane.tabCloseCallback", (BiConsumer<JTabbedPane, Integer>) (tabbedPane, tabIndex) -> { // close tab here } );EventQueue.getCurrentEvent()to get current event, check whether it is aMouseEventand invoke its methods. E.g.AWTEvent e = EventQueue.getCurrentEvent(); boolean shift = (e instanceof MouseEvent) ? ((MouseEvent)e).isShiftDown() : false;Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeIntConsumerorBiConsumer<javax.swing.JTabbedPane, Integer>- See Also:
TABBED_PANE_TAB_CLOSABLE, Constant Field Values
-
TABBED_PANE_TABS_POPUP_POLICY
static final String TABBED_PANE_TABS_POPUP_POLICY
Specifies the display policy for the "more tabs" button, which shows a popup menu with the (partly) hidden tabs.Component
JTabbedPane
Value typeString
Allowed ValuesTABBED_PANE_POLICY_NEVERorTABBED_PANE_POLICY_AS_NEEDED- See Also:
- Constant Field Values
-
TABBED_PANE_SCROLL_BUTTONS_POLICY
static final String TABBED_PANE_SCROLL_BUTTONS_POLICY
Specifies the display policy for the forward/backward scroll arrow buttons.Component
JTabbedPane
Value typeString
Allowed ValuesTABBED_PANE_POLICY_NEVER,TABBED_PANE_POLICY_AS_NEEDEDorTABBED_PANE_POLICY_AS_NEEDED_SINGLE- See Also:
- Constant Field Values
-
TABBED_PANE_POLICY_NEVER
static final String TABBED_PANE_POLICY_NEVER
Display never.
-
TABBED_PANE_POLICY_AS_NEEDED
static final String TABBED_PANE_POLICY_AS_NEEDED
Display only when needed.If used for
TABBED_PANE_SCROLL_BUTTONS_POLICY, both scroll arrow buttons are either shown or hidden. Buttons are disabled if scrolling in that direction is not applicable.
-
TABBED_PANE_POLICY_AS_NEEDED_SINGLE
static final String TABBED_PANE_POLICY_AS_NEEDED_SINGLE
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.
-
TABBED_PANE_SCROLL_BUTTONS_PLACEMENT
static final String TABBED_PANE_SCROLL_BUTTONS_PLACEMENT
Specifies the placement of the forward/backward scroll arrow buttons.Component
JTabbedPane
Value typeString
Allowed ValuesTABBED_PANE_PLACEMENT_BOTHorTABBED_PANE_PLACEMENT_TRAILING- See Also:
- Constant Field Values
-
TABBED_PANE_PLACEMENT_BOTH
static final String TABBED_PANE_PLACEMENT_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.
-
TABBED_PANE_PLACEMENT_TRAILING
static final String TABBED_PANE_PLACEMENT_TRAILING
The forward/backward scroll arrow buttons are placed on the trailing side of the tab area.
-
TABBED_PANE_TAB_AREA_ALIGNMENT
static final String TABBED_PANE_TAB_AREA_ALIGNMENT
Specifies the alignment of the tab area.Component
JTabbedPane
Value typeIntegerorString
Allowed ValuesSwingConstants.LEADING(default)SwingConstants.TRAILING,SwingConstants.CENTER,TABBED_PANE_ALIGN_LEADING(default),TABBED_PANE_ALIGN_TRAILING,TABBED_PANE_ALIGN_CENTERorTABBED_PANE_ALIGN_FILL- See Also:
- Constant Field Values
-
TABBED_PANE_TAB_ALIGNMENT
static final String TABBED_PANE_TAB_ALIGNMENT
Specifies the horizontal alignment of the tab title and icon.Component
JTabbedPaneor tab content components (seeJTabbedPane.setComponentAt(int, java.awt.Component))
Value typeIntegerorString
Allowed ValuesSwingConstants.LEADING,SwingConstants.TRAILING,SwingConstants.CENTER(default),TABBED_PANE_ALIGN_LEADING,TABBED_PANE_ALIGN_TRAILINGorTABBED_PANE_ALIGN_CENTER(default)- See Also:
- Constant Field Values
-
TABBED_PANE_ALIGN_LEADING
static final String TABBED_PANE_ALIGN_LEADING
Align to the leading edge.
-
TABBED_PANE_ALIGN_TRAILING
static final String TABBED_PANE_ALIGN_TRAILING
Align to the trailing edge.
-
TABBED_PANE_ALIGN_CENTER
static final String TABBED_PANE_ALIGN_CENTER
Align to center.
-
TABBED_PANE_ALIGN_FILL
static final String TABBED_PANE_ALIGN_FILL
Stretch to fill all available space.
-
TABBED_PANE_TAB_WIDTH_MODE
static final String TABBED_PANE_TAB_WIDTH_MODE
Specifies how the tabs should be sized.Component
JTabbedPane
Value typeString
Allowed ValuesTABBED_PANE_TAB_WIDTH_MODE_PREFERRED(default),TABBED_PANE_TAB_WIDTH_MODE_EQUALorTABBED_PANE_TAB_WIDTH_MODE_COMPACT- See Also:
- Constant Field Values
-
TABBED_PANE_TAB_WIDTH_MODE_PREFERRED
static final String TABBED_PANE_TAB_WIDTH_MODE_PREFERRED
Tab width is adjusted to tab icon and title.- See Also:
TABBED_PANE_TAB_WIDTH_MODE, Constant Field Values
-
TABBED_PANE_TAB_WIDTH_MODE_EQUAL
static final String TABBED_PANE_TAB_WIDTH_MODE_EQUAL
All tabs in a tabbed pane has same width.- See Also:
TABBED_PANE_TAB_WIDTH_MODE, Constant Field Values
-
TABBED_PANE_TAB_WIDTH_MODE_COMPACT
static final String TABBED_PANE_TAB_WIDTH_MODE_COMPACT
Unselected tabs are smaller because they show only the tab icon, but no tab title. Selected tabs show both.- See Also:
TABBED_PANE_TAB_WIDTH_MODE, Constant Field Values
-
TABBED_PANE_TAB_ICON_PLACEMENT
static final String TABBED_PANE_TAB_ICON_PLACEMENT
Specifies the tab icon placement (relative to tab title).Component
JTabbedPane
Value typeInteger
Allowed ValuesSwingConstants.LEADING(default),SwingConstants.TRAILING,SwingConstants.TOPorSwingConstants.BOTTOM- See Also:
- Constant Field Values
-
TABBED_PANE_LEADING_COMPONENT
static final String TABBED_PANE_LEADING_COMPONENT
Specifies a component that will be placed at the leading edge of the tabs area.For top and bottom tab placement, the laid out component size will be the preferred component width and the tab area height.
For left and right tab placement, the laid out component size will be the tab area width and the preferred component height.Component
JTabbedPane
Value typeComponent- See Also:
- Constant Field Values
-
TABBED_PANE_TRAILING_COMPONENT
static final String TABBED_PANE_TRAILING_COMPONENT
Specifies a component that will be placed at the trailing edge of the tabs area.For top and bottom tab placement, the laid out component size will be the available horizontal space (minimum is preferred component width) and the tab area height.
For left and right tab placement, the laid out component size will be the tab area width and the available vertical space (minimum is preferred component height).Component
JTabbedPane
Value typeComponent- See Also:
- Constant Field Values
-
SELECT_ALL_ON_FOCUS_POLICY
static final String SELECT_ALL_ON_FOCUS_POLICY
Specifies whether all text is selected when the text component gains focus.Component
JTextField(and subclasses)
Value typeString
Allowed ValuesSELECT_ALL_ON_FOCUS_POLICY_NEVER,SELECT_ALL_ON_FOCUS_POLICY_ONCE(default) orSELECT_ALL_ON_FOCUS_POLICY_ALWAYS- See Also:
- Constant Field Values
-
SELECT_ALL_ON_FOCUS_POLICY_NEVER
static final String SELECT_ALL_ON_FOCUS_POLICY_NEVER
Never select all text when the text component gains focus.- See Also:
SELECT_ALL_ON_FOCUS_POLICY, Constant Field Values
-
SELECT_ALL_ON_FOCUS_POLICY_ONCE
static final String SELECT_ALL_ON_FOCUS_POLICY_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.- See Also:
SELECT_ALL_ON_FOCUS_POLICY, Constant Field Values
-
SELECT_ALL_ON_FOCUS_POLICY_ALWAYS
static final String SELECT_ALL_ON_FOCUS_POLICY_ALWAYS
Always select all text when the text component gains focus.- See Also:
SELECT_ALL_ON_FOCUS_POLICY, Constant Field Values
-
PLACEHOLDER_TEXT
static final String PLACEHOLDER_TEXT
Placeholder text that is only painted if the text field is empty.Component
JTextField(and subclasses) orJComboBox
Value typeString- See Also:
- Constant Field Values
-
TEXT_FIELD_PADDING
static final String TEXT_FIELD_PADDING
Specifies the padding of the text. This changes the location and size of the text view within the component bounds, but does not affect the size of the component.Component
JTextField(and subclasses)
Value typeInsets- Since:
- 1.4
- See Also:
- Constant Field Values
-
TEXT_FIELD_LEADING_ICON
static final String TEXT_FIELD_LEADING_ICON
Specifies an icon that will be placed at the leading edge of the text field.Component
JTextField(and subclasses)
Value typeIcon- Since:
- 2
- See Also:
- Constant Field Values
-
TEXT_FIELD_TRAILING_ICON
static final String TEXT_FIELD_TRAILING_ICON
Specifies an icon that will be placed at the trailing edge of the text field.Component
JTextField(and subclasses)
Value typeIcon- Since:
- 2
- See Also:
- Constant Field Values
-
TEXT_FIELD_LEADING_COMPONENT
static final String TEXT_FIELD_LEADING_COMPONENT
Specifies a component that will be placed at the leading edge of the text field.The component will be positioned inside and aligned to the visible text field border. There is no gap between the visible border and the component. The laid out component size will be the preferred component width and the inner text field height.
The component should be not opaque because the text field border is painted slightly inside the usually visible border in some cases. E.g. when focused (in some themes) or when an outline color is specified (see
OUTLINE).The component is prepared in the following way:
- Component client property
STYLE_CLASSis set toinTextField. - If component is a button or toggle button, client property
BUTTON_TYPEis set toBUTTON_TYPE_TOOLBAR_BUTTONand button cursor is set to default cursor (if not set). - If component is a toolbar, client property
STYLE_CLASSis set toinTextFieldon all toolbar children and toolbar cursor is set to default cursor (if not set).
comp.setCursor( Cursor.getDefaultCursor() ).Styling is used to modify insets/margins and appearance of buttons and toolbars so that they fit nicely into the text field and do not increase text field height. See styles
[style]Button.inTextFieldand[style]ToolBar.inTextFieldinFlat[Light|Dark]Laf.properties.Component
JTextField(and subclasses)
Value typeJComponent- Since:
- 2
- See Also:
- Constant Field Values
- Component client property
-
TEXT_FIELD_TRAILING_COMPONENT
static final String TEXT_FIELD_TRAILING_COMPONENT
Specifies a component that will be placed at the trailing edge of the text field.See
TEXT_FIELD_LEADING_COMPONENTfor details.Component
JTextField(and subclasses)
Value typeJComponent- Since:
- 2
- See Also:
- Constant Field Values
-
TEXT_FIELD_SHOW_CLEAR_BUTTON
static final String TEXT_FIELD_SHOW_CLEAR_BUTTON
Specifies whether a "clear" (or "cancel") button is shown on the trailing side if the text field is not empty, editable and enabled. Default isfalse.Component
JTextField(and subclasses)
Value typeBoolean- Since:
- 2
- See Also:
- Constant Field Values
-
TEXT_FIELD_CLEAR_CALLBACK
static final String TEXT_FIELD_CLEAR_CALLBACK
Specifies the callback that is invoked when a "clear" (or "cancel") button is clicked. If a callback is specified than it is responsible for clearing the text field. Without callback, the text field clears itself.Either use a
Runnable:
Or use amyTextField.putClientProperty( "JTextField.clearCallback", (Runnable) () -> { // clear field here or cancel search } );Consumer<javax.swing.text.JTextComponent> that receives the text field as parameter:myTextField.putClientProperty( "JTextField.clearCallback", (Consumer<JTextComponent>) textField -> { // clear field here or cancel search } );Component
JTextField(and subclasses)
Value typeRunnableorConsumer<javax.swing.text.JTextComponent>- Since:
- 2
- See Also:
TEXT_FIELD_SHOW_CLEAR_BUTTON, Constant Field Values
-
TAB_BUTTON_UNDERLINE_PLACEMENT
static final String TAB_BUTTON_UNDERLINE_PLACEMENT
Placement of underline if toggle button type isBUTTON_TYPE_TABComponent
JToggleButton
Value typeInteger
SupportedValues:SwingConstants.BOTTOM(default)SwingConstants.TOP,SwingConstants.LEFTorSwingConstants.RIGHT- Since:
- 2.3
- See Also:
- Constant Field Values
-
TAB_BUTTON_UNDERLINE_HEIGHT
static final String TAB_BUTTON_UNDERLINE_HEIGHT
Thickness of underline if toggle button type isBUTTON_TYPE_TAB.Component
JToggleButton
Value typeInteger- See Also:
- Constant Field Values
-
TAB_BUTTON_UNDERLINE_COLOR
static final String TAB_BUTTON_UNDERLINE_COLOR
Color of underline if toggle button type isBUTTON_TYPE_TAB.Component
JToggleButton
Value typeColor- See Also:
- Constant Field Values
-
TAB_BUTTON_SELECTED_BACKGROUND
static final String TAB_BUTTON_SELECTED_BACKGROUND
Background color if selected and toggle button type isBUTTON_TYPE_TAB.Component
JToggleButton
Value typeColor- See Also:
- Constant Field Values
-
TREE_WIDE_SELECTION
static final String TREE_WIDE_SELECTION
- See Also:
- Constant Field Values
-
TREE_PAINT_SELECTION
static final String TREE_PAINT_SELECTION
Specifies whether tree item selection is painted. Default istrue. If set tofalse, then the tree cell renderer is responsible for painting selection.- See Also:
- Constant Field Values
-
-
Method Detail
-
clientPropertyEquals
static boolean clientPropertyEquals(JComponent c, String key, Object value)
Checks whether a client property of a component has the given value.
-
clientPropertyBoolean
static boolean clientPropertyBoolean(JComponent c, String key, boolean defaultValue)
Checks whether a client property of a component is a boolean and returns its value. If the client property is not set, or not a boolean, defaultValue is returned.
-
clientPropertyBooleanStrict
static Boolean clientPropertyBooleanStrict(JComponent c, String key, Boolean defaultValue)
-
clientPropertyInt
static int clientPropertyInt(JComponent c, String key, int defaultValue)
Checks whether a client property of a component is an integer and returns its value. If the client property is not set, or not an integer, defaultValue is returned.
-
clientPropertyColor
static Color clientPropertyColor(JComponent c, String key, Color defaultValue)
Checks whether a client property of a component is a color and returns its value. If the client property is not set, or not a color, defaultValue is returned.
-
clientProperty
static <T> T clientProperty(JComponent c, String key, T defaultValue, Class<T> type)
Returns the value of the specified client property if it is an instance of the specified type. Otherwise, defaultValue is returned.- Since:
- 2
-
-