Class Region
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 Components
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
FieldsModifier and TypeFieldDescriptionstatic final RegionArrowButton's are special types of buttons that also render a directional indicator, typically an arrow.static final RegionButton region.static final RegionCheckBox region.static final RegionCheckBoxMenuItem region.static final RegionColorChooser region.static final RegionComboBox region.static final RegionDesktopIcon region.static final RegionDesktopPane region.static final RegionEditorPane region.static final RegionFileChooser region.static final RegionFormattedTextField region.static final RegionInternalFrame region.static final RegionTitlePane of an InternalFrame.static final RegionLabel region.static final RegionList region.static final RegionMenu region.static final RegionMenuBar region.static final RegionMenuItem region.static final RegionAccelerator region of a MenuItem.static final RegionOptionPane region.static final RegionPanel region.static final RegionPasswordField region.static final RegionPopupMenu region.static final RegionPopupMenuSeparator region.static final RegionProgressBar region.static final RegionRadioButton region.static final RegionRadioButtonMenuItem region.static final RegionRootPane region.static final RegionScrollBar region.static final RegionThumb of the ScrollBar.static final RegionTrack of the ScrollBar.static final RegionScrollPane region.static final RegionSeparator region.static final RegionSlider region.static final RegionThumb of the Slider.static final RegionTrack of the Slider.static final RegionSpinner region.static final RegionSplitPane region.static final RegionDivider of the SplitPane.static final RegionTabbedPane region.static final RegionRegion of a TabbedPane containing the content.static final RegionRegion of a TabbedPane for one tab.static final RegionRegion of a TabbedPane containing the tabs.static final RegionTable region.static final RegionTableHeader region.static final RegionTextArea region.static final RegionTextField region.static final RegionTextPane region.static final RegionToggleButton region.static final RegionToolBar region.static final RegionRegion of the ToolBar containing the content.static final RegionRegion for the Window containing the ToolBar.static final RegionToolBar separator region.static final RegionToolTip region.static final RegionTree region.static final RegionRegion of the Tree for one cell.static final RegionViewport region. -
Constructor Summary
Constructors -
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 thisRegionuse the nameArrowButton. -
BUTTON
Button region. To bind a style to thisRegionuse the nameButton. -
CHECK_BOX
CheckBox region. To bind a style to thisRegionuse the nameCheckBox. -
CHECK_BOX_MENU_ITEM
CheckBoxMenuItem region. To bind a style to thisRegionuse the nameCheckBoxMenuItem. -
COLOR_CHOOSER
ColorChooser region. To bind a style to thisRegionuse the nameColorChooser. -
COMBO_BOX
ComboBox region. To bind a style to thisRegionuse the nameComboBox. -
DESKTOP_PANE
DesktopPane region. To bind a style to thisRegionuse the nameDesktopPane. -
DESKTOP_ICON
DesktopIcon region. To bind a style to thisRegionuse the nameDesktopIcon. -
EDITOR_PANE
EditorPane region. To bind a style to thisRegionuse the nameEditorPane. -
FILE_CHOOSER
FileChooser region. To bind a style to thisRegionuse the nameFileChooser. -
FORMATTED_TEXT_FIELD
FormattedTextField region. To bind a style to thisRegionuse the nameFormattedTextField. -
INTERNAL_FRAME
InternalFrame region. To bind a style to thisRegionuse 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 thisRegionuse the nameInternalFrameTitlePane. -
LABEL
Label region. To bind a style to thisRegionuse the nameLabel. -
LIST
List region. To bind a style to thisRegionuse the nameList. -
MENU
Menu region. To bind a style to thisRegionuse the nameMenu. -
MENU_BAR
MenuBar region. To bind a style to thisRegionuse the nameMenuBar. -
MENU_ITEM
MenuItem region. To bind a style to thisRegionuse the nameMenuItem. -
MENU_ITEM_ACCELERATOR
Accelerator region of a MenuItem. To bind a style to thisRegionuse the nameMenuItemAccelerator. -
OPTION_PANE
OptionPane region. To bind a style to thisRegionuse the nameOptionPane. -
PANEL
Panel region. To bind a style to thisRegionuse the namePanel. -
PASSWORD_FIELD
PasswordField region. To bind a style to thisRegionuse the namePasswordField. -
POPUP_MENU
PopupMenu region. To bind a style to thisRegionuse the namePopupMenu. -
POPUP_MENU_SEPARATOR
PopupMenuSeparator region. To bind a style to thisRegionuse the namePopupMenuSeparator. -
PROGRESS_BAR
ProgressBar region. To bind a style to thisRegionuse the nameProgressBar. -
RADIO_BUTTON
RadioButton region. To bind a style to thisRegionuse the nameRadioButton. -
RADIO_BUTTON_MENU_ITEM
RadioButtonMenuItem region. To bind a style to thisRegionuse the nameRadioButtonMenuItem. -
ROOT_PANE
RootPane region. To bind a style to thisRegionuse the nameRootPane. -
SCROLL_BAR
ScrollBar region. To bind a style to thisRegionuse the nameScrollBar. -
SCROLL_BAR_TRACK
Track of the ScrollBar. To bind a style to thisRegionuse 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 thisRegionuse the nameScrollBarThumb. -
SCROLL_PANE
ScrollPane region. To bind a style to thisRegionuse the nameScrollPane. -
SEPARATOR
Separator region. To bind a style to thisRegionuse the nameSeparator. -
SLIDER
Slider region. To bind a style to thisRegionuse the nameSlider. -
SLIDER_TRACK
Track of the Slider. To bind a style to thisRegionuse the nameSliderTrack. -
SLIDER_THUMB
Thumb of the Slider. The thumb of the Slider identifies the current value. To bind a style to thisRegionuse the nameSliderThumb. -
SPINNER
Spinner region. To bind a style to thisRegionuse the nameSpinner. -
SPLIT_PANE
SplitPane region. To bind a style to thisRegionuse the nameSplitPane. -
SPLIT_PANE_DIVIDER
Divider of the SplitPane. To bind a style to thisRegionuse the nameSplitPaneDivider. -
TABBED_PANE
TabbedPane region. To bind a style to thisRegionuse the nameTabbedPane. -
TABBED_PANE_TAB
Region of a TabbedPane for one tab. To bind a style to thisRegionuse the nameTabbedPaneTab. -
TABBED_PANE_TAB_AREA
Region of a TabbedPane containing the tabs. To bind a style to thisRegionuse the nameTabbedPaneTabArea. -
TABBED_PANE_CONTENT
Region of a TabbedPane containing the content. To bind a style to thisRegionuse the nameTabbedPaneContent. -
TABLE
Table region. To bind a style to thisRegionuse the nameTable. -
TABLE_HEADER
TableHeader region. To bind a style to thisRegionuse the nameTableHeader. -
TEXT_AREA
TextArea region. To bind a style to thisRegionuse the nameTextArea. -
TEXT_FIELD
TextField region. To bind a style to thisRegionuse the nameTextField. -
TEXT_PANE
TextPane region. To bind a style to thisRegionuse the nameTextPane. -
TOGGLE_BUTTON
ToggleButton region. To bind a style to thisRegionuse the nameToggleButton. -
TOOL_BAR
ToolBar region. To bind a style to thisRegionuse the nameToolBar. -
TOOL_BAR_CONTENT
Region of the ToolBar containing the content. To bind a style to thisRegionuse the nameToolBarContent. -
TOOL_BAR_DRAG_WINDOW
Region for the Window containing the ToolBar. To bind a style to thisRegionuse the nameToolBarDragWindow. -
TOOL_TIP
ToolTip region. To bind a style to thisRegionuse the nameToolTip. -
TOOL_BAR_SEPARATOR
ToolBar separator region. To bind a style to thisRegionuse the nameToolBarSeparator. -
TREE
Tree region. To bind a style to thisRegionuse the nameTree. -
TREE_CELL
Region of the Tree for one cell. To bind a style to thisRegionuse the nameTreeCell. -
VIEWPORT
Viewport region. To bind a style to thisRegionuse the nameViewport.
-
-
Constructor Details
-
Region
Creates a Region with the specified name. This should only be used if you are creating your ownJComponentsubclass with a customComponentUIclass.- 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.BUTTONcorresponds do aComponentso thatRegion.BUTTON.isSubregion()returns false.- Returns:
- true if the Region is a subregion of a Component.
-
getName
-
toString
-