Region (Java Platform SE 8 )

java.lang.Object
- javax.swing.plaf.synth.Region

```
public class Region
extends Object
```
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:
1. Map all characters to lowercase.
2. Map the first character to uppercase.
3. Map the first character after underscores to uppercase.
4. Remove all underscores.
For example, to identify the 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

Fields
Modifier and Type	Field and Description
`static Region`	`ARROW_BUTTON` ArrowButton's are special types of buttons that also render a directional indicator, typically an arrow.
`static Region`	`BUTTON` Button region.
`static Region`	`CHECK_BOX` CheckBox region.
`static Region`	`CHECK_BOX_MENU_ITEM` CheckBoxMenuItem region.
`static Region`	`COLOR_CHOOSER` ColorChooser region.
`static Region`	`COMBO_BOX` ComboBox region.
`static Region`	`DESKTOP_ICON` DesktopIcon region.
`static Region`	`DESKTOP_PANE` DesktopPane region.
`static Region`	`EDITOR_PANE` EditorPane region.
`static Region`	`FILE_CHOOSER` FileChooser region.
`static Region`	`FORMATTED_TEXT_FIELD` FormattedTextField region.
`static Region`	`INTERNAL_FRAME` InternalFrame region.
`static Region`	`INTERNAL_FRAME_TITLE_PANE` TitlePane of an InternalFrame.
`static Region`	`LABEL` Label region.
`static Region`	`LIST` List region.
`static Region`	`MENU` Menu region.
`static Region`	`MENU_BAR` MenuBar region.
`static Region`	`MENU_ITEM` MenuItem region.
`static Region`	`MENU_ITEM_ACCELERATOR` Accelerator region of a MenuItem.
`static Region`	`OPTION_PANE` OptionPane region.
`static Region`	`PANEL` Panel region.
`static Region`	`PASSWORD_FIELD` PasswordField region.
`static Region`	`POPUP_MENU` PopupMenu region.
`static Region`	`POPUP_MENU_SEPARATOR` PopupMenuSeparator region.
`static Region`	`PROGRESS_BAR` ProgressBar region.
`static Region`	`RADIO_BUTTON` RadioButton region.
`static Region`	`RADIO_BUTTON_MENU_ITEM` RegionButtonMenuItem region.
`static Region`	`ROOT_PANE` RootPane region.
`static Region`	`SCROLL_BAR` ScrollBar region.
`static Region`	`SCROLL_BAR_THUMB` Thumb of the ScrollBar.
`static Region`	`SCROLL_BAR_TRACK` Track of the ScrollBar.
`static Region`	`SCROLL_PANE` ScrollPane region.
`static Region`	`SEPARATOR` Separator region.
`static Region`	`SLIDER` Slider region.
`static Region`	`SLIDER_THUMB` Thumb of the Slider.
`static Region`	`SLIDER_TRACK` Track of the Slider.
`static Region`	`SPINNER` Spinner region.
`static Region`	`SPLIT_PANE` SplitPane region.
`static Region`	`SPLIT_PANE_DIVIDER` Divider of the SplitPane.
`static Region`	`TABBED_PANE` TabbedPane region.
`static Region`	`TABBED_PANE_CONTENT` Region of a TabbedPane containing the content.
`static Region`	`TABBED_PANE_TAB` Region of a TabbedPane for one tab.
`static Region`	`TABBED_PANE_TAB_AREA` Region of a TabbedPane containing the tabs.
`static Region`	`TABLE` Table region.
`static Region`	`TABLE_HEADER` TableHeader region.
`static Region`	`TEXT_AREA` TextArea region.
`static Region`	`TEXT_FIELD` TextField region.
`static Region`	`TEXT_PANE` TextPane region.
`static Region`	`TOGGLE_BUTTON` ToggleButton region.
`static Region`	`TOOL_BAR` ToolBar region.
`static Region`	`TOOL_BAR_CONTENT` Region of the ToolBar containing the content.
`static Region`	`TOOL_BAR_DRAG_WINDOW` Region for the Window containing the ToolBar.
`static Region`	`TOOL_BAR_SEPARATOR` ToolBar separator region.
`static Region`	`TOOL_TIP` ToolTip region.
`static Region`	`TREE` Tree region.
`static Region`	`TREE_CELL` Region of the Tree for one cell.
`static Region`	`VIEWPORT` Viewport region.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Region(String name, String ui, boolean subregion)
Creates a Region with the specified name.

Constructors
Modifier	Constructor and Description
`protected`	`Region(String name, String ui, boolean subregion)` Creates a Region with the specified name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Returns the name of the region.
`boolean`	`isSubregion()` Returns true if the Region is a subregion of a Component, otherwise false.
`String`	`toString()` Returns the name of the Region.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ARROW_BUTTON
```
public static final Region 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 this Region use the name ArrowButton.
  - BUTTON
```
public static final Region BUTTON
```
    Button region. To bind a style to this Region use the name Button.
  - CHECK_BOX
```
public static final Region CHECK_BOX
```
    CheckBox region. To bind a style to this Region use the name CheckBox.
  - CHECK_BOX_MENU_ITEM
```
public static final Region CHECK_BOX_MENU_ITEM
```
    CheckBoxMenuItem region. To bind a style to this Region use the name CheckBoxMenuItem.
  - COLOR_CHOOSER
```
public static final Region COLOR_CHOOSER
```
    ColorChooser region. To bind a style to this Region use the name ColorChooser.
  - COMBO_BOX
```
public static final Region COMBO_BOX
```
    ComboBox region. To bind a style to this Region use the name ComboBox.
  - DESKTOP_PANE
```
public static final Region DESKTOP_PANE
```
    DesktopPane region. To bind a style to this Region use the name DesktopPane.
  - DESKTOP_ICON
```
public static final Region DESKTOP_ICON
```
    DesktopIcon region. To bind a style to this Region use the name DesktopIcon.
  - EDITOR_PANE
```
public static final Region EDITOR_PANE
```
    EditorPane region. To bind a style to this Region use the name EditorPane.
  - FILE_CHOOSER
```
public static final Region FILE_CHOOSER
```
    FileChooser region. To bind a style to this Region use the name FileChooser.
  - FORMATTED_TEXT_FIELD
```
public static final Region FORMATTED_TEXT_FIELD
```
    FormattedTextField region. To bind a style to this Region use the name FormattedTextField.
  - INTERNAL_FRAME
```
public static final Region INTERNAL_FRAME
```
    InternalFrame region. To bind a style to this Region use the name InternalFrame.
  - INTERNAL_FRAME_TITLE_PANE
```
public static final Region 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 this Region use the name InternalFrameTitlePane.
  - LABEL
```
public static final Region LABEL
```
    Label region. To bind a style to this Region use the name Label.
  - LIST
```
public static final Region LIST
```
    List region. To bind a style to this Region use the name List.
  - MENU
```
public static final Region MENU
```
    Menu region. To bind a style to this Region use the name Menu.
  - MENU_BAR
```
public static final Region MENU_BAR
```
    MenuBar region. To bind a style to this Region use the name MenuBar.
  - MENU_ITEM
```
public static final Region MENU_ITEM
```
    MenuItem region. To bind a style to this Region use the name MenuItem.
  - MENU_ITEM_ACCELERATOR
```
public static final Region MENU_ITEM_ACCELERATOR
```
    Accelerator region of a MenuItem. To bind a style to this Region use the name MenuItemAccelerator.
  - OPTION_PANE
```
public static final Region OPTION_PANE
```
    OptionPane region. To bind a style to this Region use the name OptionPane.
  - PANEL
```
public static final Region PANEL
```
    Panel region. To bind a style to this Region use the name Panel.
  - PASSWORD_FIELD
```
public static final Region PASSWORD_FIELD
```
    PasswordField region. To bind a style to this Region use the name PasswordField.
  - POPUP_MENU
```
public static final Region POPUP_MENU
```
    PopupMenu region. To bind a style to this Region use the name PopupMenu.
  - POPUP_MENU_SEPARATOR
```
public static final Region POPUP_MENU_SEPARATOR
```
    PopupMenuSeparator region. To bind a style to this Region use the name PopupMenuSeparator.
  - PROGRESS_BAR
```
public static final Region PROGRESS_BAR
```
    ProgressBar region. To bind a style to this Region use the name ProgressBar.
  - RADIO_BUTTON
```
public static final Region RADIO_BUTTON
```
    RadioButton region. To bind a style to this Region use the name RadioButton.
  - RADIO_BUTTON_MENU_ITEM
```
public static final Region RADIO_BUTTON_MENU_ITEM
```
    RegionButtonMenuItem region. To bind a style to this Region use the name RadioButtonMenuItem.
  - ROOT_PANE
```
public static final Region ROOT_PANE
```
    RootPane region. To bind a style to this Region use the name RootPane.
  - SCROLL_BAR
```
public static final Region SCROLL_BAR
```
    ScrollBar region. To bind a style to this Region use the name ScrollBar.
  - SCROLL_BAR_TRACK
```
public static final Region SCROLL_BAR_TRACK
```
    Track of the ScrollBar. To bind a style to this Region use the name ScrollBarTrack.
  - SCROLL_BAR_THUMB
```
public static final Region 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 this Region use the name ScrollBarThumb.
  - SCROLL_PANE
```
public static final Region SCROLL_PANE
```
    ScrollPane region. To bind a style to this Region use the name ScrollPane.
  - SEPARATOR
```
public static final Region SEPARATOR
```
    Separator region. To bind a style to this Region use the name Separator.
  - SLIDER
```
public static final Region SLIDER
```
    Slider region. To bind a style to this Region use the name Slider.
  - SLIDER_TRACK
```
public static final Region SLIDER_TRACK
```
    Track of the Slider. To bind a style to this Region use the name SliderTrack.
  - SLIDER_THUMB
```
public static final Region SLIDER_THUMB
```
    Thumb of the Slider. The thumb of the Slider identifies the current value. To bind a style to this Region use the name SliderThumb.
  - SPINNER
```
public static final Region SPINNER
```
    Spinner region. To bind a style to this Region use the name Spinner.
  - SPLIT_PANE
```
public static final Region SPLIT_PANE
```
    SplitPane region. To bind a style to this Region use the name SplitPane.
  - SPLIT_PANE_DIVIDER
```
public static final Region SPLIT_PANE_DIVIDER
```
    Divider of the SplitPane. To bind a style to this Region use the name SplitPaneDivider.
  - TABBED_PANE
```
public static final Region TABBED_PANE
```
    TabbedPane region. To bind a style to this Region use the name TabbedPane.
  - TABBED_PANE_TAB
```
public static final Region TABBED_PANE_TAB
```
    Region of a TabbedPane for one tab. To bind a style to this Region use the name TabbedPaneTab.
  - TABBED_PANE_TAB_AREA
```
public static final Region TABBED_PANE_TAB_AREA
```
    Region of a TabbedPane containing the tabs. To bind a style to this Region use the name TabbedPaneTabArea.
  - TABBED_PANE_CONTENT
```
public static final Region TABBED_PANE_CONTENT
```
    Region of a TabbedPane containing the content. To bind a style to this Region use the name TabbedPaneContent.
  - TABLE
```
public static final Region TABLE
```
    Table region. To bind a style to this Region use the name Table.
  - TABLE_HEADER
```
public static final Region TABLE_HEADER
```
    TableHeader region. To bind a style to this Region use the name TableHeader.
  - TEXT_AREA
```
public static final Region TEXT_AREA
```
    TextArea region. To bind a style to this Region use the name TextArea.
  - TEXT_FIELD
```
public static final Region TEXT_FIELD
```
    TextField region. To bind a style to this Region use the name TextField.
  - TEXT_PANE
```
public static final Region TEXT_PANE
```
    TextPane region. To bind a style to this Region use the name TextPane.
  - TOGGLE_BUTTON
```
public static final Region TOGGLE_BUTTON
```
    ToggleButton region. To bind a style to this Region use the name ToggleButton.
  - TOOL_BAR
```
public static final Region TOOL_BAR
```
    ToolBar region. To bind a style to this Region use the name ToolBar.
  - TOOL_BAR_CONTENT
```
public static final Region TOOL_BAR_CONTENT
```
    Region of the ToolBar containing the content. To bind a style to this Region use the name ToolBarContent.
  - TOOL_BAR_DRAG_WINDOW
```
public static final Region TOOL_BAR_DRAG_WINDOW
```
    Region for the Window containing the ToolBar. To bind a style to this Region use the name ToolBarDragWindow.
  - TOOL_TIP
```
public static final Region TOOL_TIP
```
    ToolTip region. To bind a style to this Region use the name ToolTip.
  - TOOL_BAR_SEPARATOR
```
public static final Region TOOL_BAR_SEPARATOR
```
    ToolBar separator region. To bind a style to this Region use the name ToolBarSeparator.
  - TREE
```
public static final Region TREE
```
    Tree region. To bind a style to this Region use the name Tree.
  - TREE_CELL
```
public static final Region TREE_CELL
```
    Region of the Tree for one cell. To bind a style to this Region use the name TreeCell.
  - VIEWPORT
```
public static final Region VIEWPORT
```
    Viewport region. To bind a style to this Region use the name Viewport.
- Constructor Detail
  - Region
```
protected Region(String name,
                 String ui,
                 boolean subregion)
```
    Creates a Region with the specified name. This should only be used if you are creating your own JComponent subclass with a custom ComponentUI class.
    
    Parameters:
    
    name - Name of the region
    
    ui - String that will be returned from component.getUIClassID. This will be null if this is a subregion.
    
    subregion - Whether or not this is a subregion.
- Method Detail
  - isSubregion
```
public boolean isSubregion()
```
    Returns true if the Region is a subregion of a Component, otherwise false. For example, Region.BUTTON corresponds do a Component so that Region.BUTTON.isSubregion() returns false.
    
    Returns:
    
    true if the Region is a subregion of a Component.
  - getName
```
public String getName()
```
    Returns the name of the region.
    
    Returns:
    
    name of the Region.
  - toString
```
public String toString()
```
    Returns the name of the Region.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    name of the Region.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2024, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Class Region

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ARROW_BUTTON

BUTTON

CHECK_BOX

CHECK_BOX_MENU_ITEM

COLOR_CHOOSER

COMBO_BOX

DESKTOP_PANE

DESKTOP_ICON

EDITOR_PANE

FILE_CHOOSER

FORMATTED_TEXT_FIELD

INTERNAL_FRAME

INTERNAL_FRAME_TITLE_PANE

LABEL

LIST

MENU

MENU_BAR

MENU_ITEM

MENU_ITEM_ACCELERATOR

OPTION_PANE

PANEL

PASSWORD_FIELD

POPUP_MENU

POPUP_MENU_SEPARATOR

PROGRESS_BAR

RADIO_BUTTON

RADIO_BUTTON_MENU_ITEM

ROOT_PANE

SCROLL_BAR

SCROLL_BAR_TRACK

SCROLL_BAR_THUMB

SCROLL_PANE

SEPARATOR

SLIDER

SLIDER_TRACK

SLIDER_THUMB

SPINNER

SPLIT_PANE

SPLIT_PANE_DIVIDER

TABBED_PANE

TABBED_PANE_TAB

TABBED_PANE_TAB_AREA

TABBED_PANE_CONTENT

TABLE

TABLE_HEADER

TEXT_AREA

TEXT_FIELD

TEXT_PANE

TOGGLE_BUTTON

TOOL_BAR

TOOL_BAR_CONTENT

TOOL_BAR_DRAG_WINDOW

TOOL_TIP

TOOL_BAR_SEPARATOR

TREE

TREE_CELL

VIEWPORT

Constructor Detail

Region

Method Detail

isSubregion

getName

toString