java.lang.Object
javax.swing.plaf.synth.Region
A distinct rendering area of a Swing component. A component may
support one or more regions. Specific component regions are defined
by the typesafe enumeration in this class.
Regions are typically used as a way to identify the Component
s
and areas a particular style is to apply to. Synth's file format allows you
to bind styles based on the name of a Region
.
The name is derived from the field name of the constant:
- Map all characters to lowercase.
- Map the first character to uppercase.
- Map the first character after underscores to uppercase.
- Remove all underscores.
SPLIT_PANE
Region
you would use SplitPane
.
The following shows a custom SynthStyleFactory
that returns a specific style for split panes:
public SynthStyle getStyle(JComponent c, Region id) { if (id == Region.SPLIT_PANE) { return splitPaneStyle; } ... }The following xml accomplishes the same thing:
<style id="splitPaneStyle"> ... </style> <bind style="splitPaneStyle" type="region" key="SplitPane"/>
- Since:
- 1.5
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Region
ArrowButton's are special types of buttons that also render a directional indicator, typically an arrow.static final Region
Button region.static final Region
CheckBox region.static final Region
CheckBoxMenuItem region.static final Region
ColorChooser region.static final Region
ComboBox region.static final Region
DesktopIcon region.static final Region
DesktopPane region.static final Region
EditorPane region.static final Region
FileChooser region.static final Region
FormattedTextField region.static final Region
InternalFrame region.static final Region
TitlePane of an InternalFrame.static final Region
Label region.static final Region
List region.static final Region
Menu region.static final Region
MenuBar region.static final Region
MenuItem region.static final Region
Accelerator region of a MenuItem.static final Region
OptionPane region.static final Region
Panel region.static final Region
PasswordField region.static final Region
PopupMenu region.static final Region
PopupMenuSeparator region.static final Region
ProgressBar region.static final Region
RadioButton region.static final Region
RadioButtonMenuItem region.static final Region
RootPane region.static final Region
ScrollBar region.static final Region
Thumb of the ScrollBar.static final Region
Track of the ScrollBar.static final Region
ScrollPane region.static final Region
Separator region.static final Region
Slider region.static final Region
Thumb of the Slider.static final Region
Track of the Slider.static final Region
Spinner region.static final Region
SplitPane region.static final Region
Divider of the SplitPane.static final Region
TabbedPane region.static final Region
Region of a TabbedPane containing the content.static final Region
Region of a TabbedPane for one tab.static final Region
Region of a TabbedPane containing the tabs.static final Region
Table region.static final Region
TableHeader region.static final Region
TextArea region.static final Region
TextField region.static final Region
TextPane region.static final Region
ToggleButton region.static final Region
ToolBar region.static final Region
Region of the ToolBar containing the content.static final Region
Region for the Window containing the ToolBar.static final Region
ToolBar separator region.static final Region
ToolTip region.static final Region
Tree region.static final Region
Region of the Tree for one cell.static final Region
Viewport region. -
Constructor Summary
-
Method Summary
-
Field Details
-
ARROW_BUTTON
ArrowButton's are special types of buttons that also render a directional indicator, typically an arrow. ArrowButtons are used by composite components, for example ScrollBar's contain ArrowButtons. To bind a style to thisRegion
use the nameArrowButton
. -
BUTTON
Button region. To bind a style to thisRegion
use the nameButton
. -
CHECK_BOX
CheckBox region. To bind a style to thisRegion
use the nameCheckBox
. -
CHECK_BOX_MENU_ITEM
CheckBoxMenuItem region. To bind a style to thisRegion
use the nameCheckBoxMenuItem
. -
COLOR_CHOOSER
ColorChooser region. To bind a style to thisRegion
use the nameColorChooser
. -
COMBO_BOX
ComboBox region. To bind a style to thisRegion
use the nameComboBox
. -
DESKTOP_PANE
DesktopPane region. To bind a style to thisRegion
use the nameDesktopPane
. -
DESKTOP_ICON
DesktopIcon region. To bind a style to thisRegion
use the nameDesktopIcon
. -
EDITOR_PANE
EditorPane region. To bind a style to thisRegion
use the nameEditorPane
. -
FILE_CHOOSER
FileChooser region. To bind a style to thisRegion
use the nameFileChooser
. -
FORMATTED_TEXT_FIELD
FormattedTextField region. To bind a style to thisRegion
use the nameFormattedTextField
. -
INTERNAL_FRAME
InternalFrame region. To bind a style to thisRegion
use the nameInternalFrame
. -
INTERNAL_FRAME_TITLE_PANE
TitlePane of an InternalFrame. The TitlePane typically shows a menu, title, widgets to manipulate the internal frame. To bind a style to thisRegion
use the nameInternalFrameTitlePane
. -
LABEL
Label region. To bind a style to thisRegion
use the nameLabel
. -
LIST
List region. To bind a style to thisRegion
use the nameList
. -
MENU
Menu region. To bind a style to thisRegion
use the nameMenu
. -
MENU_BAR
MenuBar region. To bind a style to thisRegion
use the nameMenuBar
. -
MENU_ITEM
MenuItem region. To bind a style to thisRegion
use the nameMenuItem
. -
MENU_ITEM_ACCELERATOR
Accelerator region of a MenuItem. To bind a style to thisRegion
use the nameMenuItemAccelerator
. -
OPTION_PANE
OptionPane region. To bind a style to thisRegion
use the nameOptionPane
. -
PANEL
Panel region. To bind a style to thisRegion
use the namePanel
. -
PASSWORD_FIELD
PasswordField region. To bind a style to thisRegion
use the namePasswordField
. -
POPUP_MENU
PopupMenu region. To bind a style to thisRegion
use the namePopupMenu
. -
POPUP_MENU_SEPARATOR
PopupMenuSeparator region. To bind a style to thisRegion
use the namePopupMenuSeparator
. -
PROGRESS_BAR
ProgressBar region. To bind a style to thisRegion
use the nameProgressBar
. -
RADIO_BUTTON
RadioButton region. To bind a style to thisRegion
use the nameRadioButton
. -
RADIO_BUTTON_MENU_ITEM
RadioButtonMenuItem region. To bind a style to thisRegion
use the nameRadioButtonMenuItem
. -
ROOT_PANE
RootPane region. To bind a style to thisRegion
use the nameRootPane
. -
SCROLL_BAR
ScrollBar region. To bind a style to thisRegion
use the nameScrollBar
. -
SCROLL_BAR_TRACK
Track of the ScrollBar. To bind a style to thisRegion
use the nameScrollBarTrack
. -
SCROLL_BAR_THUMB
Thumb of the ScrollBar. The thumb is the region of the ScrollBar that gives a graphical depiction of what percentage of the View is currently visible. To bind a style to thisRegion
use the nameScrollBarThumb
. -
SCROLL_PANE
ScrollPane region. To bind a style to thisRegion
use the nameScrollPane
. -
SEPARATOR
Separator region. To bind a style to thisRegion
use the nameSeparator
. -
SLIDER
Slider region. To bind a style to thisRegion
use the nameSlider
. -
SLIDER_TRACK
Track of the Slider. To bind a style to thisRegion
use the nameSliderTrack
. -
SLIDER_THUMB
Thumb of the Slider. The thumb of the Slider identifies the current value. To bind a style to thisRegion
use the nameSliderThumb
. -
SPINNER
Spinner region. To bind a style to thisRegion
use the nameSpinner
. -
SPLIT_PANE
SplitPane region. To bind a style to thisRegion
use the nameSplitPane
. -
SPLIT_PANE_DIVIDER
Divider of the SplitPane. To bind a style to thisRegion
use the nameSplitPaneDivider
. -
TABBED_PANE
TabbedPane region. To bind a style to thisRegion
use the nameTabbedPane
. -
TABBED_PANE_TAB
Region of a TabbedPane for one tab. To bind a style to thisRegion
use the nameTabbedPaneTab
. -
TABBED_PANE_TAB_AREA
Region of a TabbedPane containing the tabs. To bind a style to thisRegion
use the nameTabbedPaneTabArea
. -
TABBED_PANE_CONTENT
Region of a TabbedPane containing the content. To bind a style to thisRegion
use the nameTabbedPaneContent
. -
TABLE
Table region. To bind a style to thisRegion
use the nameTable
. -
TABLE_HEADER
TableHeader region. To bind a style to thisRegion
use the nameTableHeader
. -
TEXT_AREA
TextArea region. To bind a style to thisRegion
use the nameTextArea
. -
TEXT_FIELD
TextField region. To bind a style to thisRegion
use the nameTextField
. -
TEXT_PANE
TextPane region. To bind a style to thisRegion
use the nameTextPane
. -
TOGGLE_BUTTON
ToggleButton region. To bind a style to thisRegion
use the nameToggleButton
. -
TOOL_BAR
ToolBar region. To bind a style to thisRegion
use the nameToolBar
. -
TOOL_BAR_CONTENT
Region of the ToolBar containing the content. To bind a style to thisRegion
use the nameToolBarContent
. -
TOOL_BAR_DRAG_WINDOW
Region for the Window containing the ToolBar. To bind a style to thisRegion
use the nameToolBarDragWindow
. -
TOOL_TIP
ToolTip region. To bind a style to thisRegion
use the nameToolTip
. -
TOOL_BAR_SEPARATOR
ToolBar separator region. To bind a style to thisRegion
use the nameToolBarSeparator
. -
TREE
Tree region. To bind a style to thisRegion
use the nameTree
. -
TREE_CELL
Region of the Tree for one cell. To bind a style to thisRegion
use the nameTreeCell
. -
VIEWPORT
Viewport region. To bind a style to thisRegion
use the nameViewport
.
-
-
Constructor Details
-
Region
Creates a Region with the specified name. This should only be used if you are creating your ownJComponent
subclass with a customComponentUI
class.- Parameters:
name
- Name of the regionui
- String that will be returned fromcomponent.getUIClassID
. This will be null if this is a subregion.subregion
- Whether or not this is a subregion.
-
-
Method Details
-
isSubregion
public boolean isSubregion()Returns true if the Region is a subregion of a Component, otherwise false. For example,Region.BUTTON
corresponds do aComponent
so thatRegion.BUTTON.isSubregion()
returns false.- Returns:
- true if the Region is a subregion of a Component.
-
getName
Returns the name of the region.- Returns:
- name of the Region.
-
toString
Returns the name of the Region.
-