javax.swing.plaf.synth

Class Region


public class Region
extends Object

Describes a region of a component or the complete component.
Since:
1.5

Field Summary

static Region
ARROW_BUTTON
Specifies an arrow button region.
static Region
BUTTON
Specifies the region of a standard button.
static Region
CHECK_BOX
Specifies the region of a check box.
static Region
CHECK_BOX_MENU_ITEM
Specifies the region of a check box menu item.
static Region
COLOR_CHOOSER
Specifies the region of a colorchooser.
static Region
COMBO_BOX
Specifies the region of a combo box.
static Region
DESKTOP_ICON
Specifies the region of a desktop icon.
static Region
DESKTOP_PANE
Specifies the region of a desktop pane.
static Region
EDITOR_PANE
Specifies the region of an editor pane.
static Region
FILE_CHOOSER
Specifies the region of a file chooser.
static Region
FORMATTED_TEXT_FIELD
Specifies the region of a formatted text field.
static Region
INTERNAL_FRAME
Specifies the region of an internal frame.
static Region
INTERNAL_FRAME_TITLE_PANE
Specifies the region of the title pane of an internal frame.
static Region
LABEL
Specifies the region of a label.
static Region
LIST
Specifies the region of a list.
static Region
MENU
Specifies the region of a menu.
static Region
MENU_BAR
Specifies the region of a menu bar.
static Region
MENU_ITEM
Specifies the region of a menu item.
static Region
MENU_ITEM_ACCELERATOR
Specifies the region of a menu item accelerator.
static Region
OPTION_PANE
Specifies the region of an option pane.
static Region
PANEL
Specifies the region of a panel.
static Region
PASSWORD_FIELD
Specifies the region of a password field.
static Region
POPUP_MENU
Specifies the region of a popup menu.
static Region
POPUP_MENU_SEPARATOR
Specifies the region of a popup menu separator.
static Region
PROGRESS_BAR
Specifies the region of a progress bar.
static Region
RADIO_BUTTON
Specifies the region of a radio button.
static Region
RADIO_BUTTON_MENU_ITEM
Specifies the region of a radio button menu item.
static Region
ROOT_PANE
Specifies the region of a root pane.
static Region
SCROLL_BAR
Specifies the region of a scroll bar.
static Region
SCROLL_BAR_THUMB
Specifies the region of a scroll bar thumb.
static Region
SCROLL_BAR_TRACK
Specifies the region of a scroll bar track.
static Region
SCROLL_PANE
Specifies the region of a scroll pane.
static Region
SEPARATOR
Specifies the region of a separator.
static Region
SLIDER
Specifies the region of a slider.
static Region
SLIDER_THUMB
Specifies the region of a slider thumb.
static Region
SLIDER_TRACK
Specifies the region of a slider track.
static Region
SPINNER
Specifies the region of a spinner.
static Region
SPLIT_PANE
Specifies the region of a split pane.
static Region
SPLIT_PANE_DIVIDER
Specifies the region of a split pane divider.
static Region
TABBED_PANE
Specifies the region of a tabbed pane.
static Region
TABBED_PANE_CONTENT
This specifies the region for the content of a tabbed pane.
static Region
TABBED_PANE_TAB
This specifies the region of a tab of a tabbed pane.
static Region
TABBED_PANE_TAB_AREA
This specifies the region underneath the tabs of a tabbed pane.
static Region
TABLE
Specifies the region of a table.
static Region
TABLE_HEADER
Specifies the region of a table header.
static Region
TEXT_AREA
Specifies the region of a text area.
static Region
TEXT_FIELD
Specifies the region of a text field.
static Region
TEXT_PANE
Specifies the region of a text pane.
static Region
TOGGLE_BUTTON
Specifies the region of a toggle button.
static Region
TOOL_BAR
Specifies the region of a tool bar.
static Region
TOOL_BAR_CONTENT
Specifies the content region of a tool bar.
static Region
TOOL_BAR_DRAG_WINDOW
Specifies the drag window region of a tool bar.
static Region
TOOL_BAR_SEPARATOR
Specifies the region of a separator of a tool bar.
static Region
TOOL_TIP
Specifies the region of a tool tip.
static Region
TREE
Specifies the region of a tree.
static Region
TREE_CELL
Specifies the region of a tree cell.
static Region
VIEWPORT
Specifies the region of a viewport.

Constructor Summary

Region(String name, String ui, boolean subregion)
Creates a new Region with the specified name and ui ID.

Method Summary

String
getName()
Returns the name of the region.
boolean
isSubregion()
Returns true if this region describes a subregion of a component, false if it describes a component region itself.
String
toString()
Returns the name of the region.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ARROW_BUTTON

public static final Region ARROW_BUTTON
Specifies an arrow button region.

BUTTON

public static final Region BUTTON
Specifies the region of a standard button.

CHECK_BOX

public static final Region CHECK_BOX
Specifies the region of a check box.

CHECK_BOX_MENU_ITEM

public static final Region CHECK_BOX_MENU_ITEM
Specifies the region of a check box menu item.

COLOR_CHOOSER

public static final Region COLOR_CHOOSER
Specifies the region of a colorchooser.

COMBO_BOX

public static final Region COMBO_BOX
Specifies the region of a combo box.

DESKTOP_ICON

public static final Region DESKTOP_ICON
Specifies the region of a desktop icon.

DESKTOP_PANE

public static final Region DESKTOP_PANE
Specifies the region of a desktop pane.

EDITOR_PANE

public static final Region EDITOR_PANE
Specifies the region of an editor pane.

FILE_CHOOSER

public static final Region FILE_CHOOSER
Specifies the region of a file chooser.

FORMATTED_TEXT_FIELD

public static final Region FORMATTED_TEXT_FIELD
Specifies the region of a formatted text field.

INTERNAL_FRAME

public static final Region INTERNAL_FRAME
Specifies the region of an internal frame.

INTERNAL_FRAME_TITLE_PANE

public static final Region INTERNAL_FRAME_TITLE_PANE
Specifies the region of the title pane of an internal frame.

LABEL

public static final Region LABEL
Specifies the region of a label.

LIST

public static final Region LIST
Specifies the region of a list.

MENU

public static final Region MENU
Specifies the region of a menu.

MENU_BAR

public static final Region MENU_BAR
Specifies the region of a menu bar.

MENU_ITEM

public static final Region MENU_ITEM
Specifies the region of a menu item.

MENU_ITEM_ACCELERATOR

public static final Region MENU_ITEM_ACCELERATOR
Specifies the region of a menu item accelerator. This is a subregion of menu item.

OPTION_PANE

public static final Region OPTION_PANE
Specifies the region of an option pane.

PANEL

public static final Region PANEL
Specifies the region of a panel.

PASSWORD_FIELD

public static final Region PASSWORD_FIELD
Specifies the region of a password field.

POPUP_MENU

public static final Region POPUP_MENU
Specifies the region of a popup menu.

POPUP_MENU_SEPARATOR

public static final Region POPUP_MENU_SEPARATOR
Specifies the region of a popup menu separator.

PROGRESS_BAR

public static final Region PROGRESS_BAR
Specifies the region of a progress bar.

RADIO_BUTTON

public static final Region RADIO_BUTTON
Specifies the region of a radio button.

RADIO_BUTTON_MENU_ITEM

public static final Region RADIO_BUTTON_MENU_ITEM
Specifies the region of a radio button menu item.

ROOT_PANE

public static final Region ROOT_PANE
Specifies the region of a root pane.

SCROLL_BAR

public static final Region SCROLL_BAR
Specifies the region of a scroll bar.

SCROLL_BAR_THUMB

public static final Region SCROLL_BAR_THUMB
Specifies the region of a scroll bar thumb. This is a subregion of scroll bars.

SCROLL_BAR_TRACK

public static final Region SCROLL_BAR_TRACK
Specifies the region of a scroll bar track. This is a subregion of scroll bars.

SCROLL_PANE

public static final Region SCROLL_PANE
Specifies the region of a scroll pane.

SEPARATOR

public static final Region SEPARATOR
Specifies the region of a separator.

SLIDER

public static final Region SLIDER
Specifies the region of a slider.

SLIDER_THUMB

public static final Region SLIDER_THUMB
Specifies the region of a slider thumb. This is a subregion of a slider.

SLIDER_TRACK

public static final Region SLIDER_TRACK
Specifies the region of a slider track. This is a subregion of a slider.

SPINNER

public static final Region SPINNER
Specifies the region of a spinner.

SPLIT_PANE

public static final Region SPLIT_PANE
Specifies the region of a split pane.

SPLIT_PANE_DIVIDER

public static final Region SPLIT_PANE_DIVIDER
Specifies the region of a split pane divider. This is a subregion of a split pane.

TABBED_PANE

public static final Region TABBED_PANE
Specifies the region of a tabbed pane.

TABBED_PANE_CONTENT

public static final Region TABBED_PANE_CONTENT
This specifies the region for the content of a tabbed pane. This is a subregion of a tabbed pane.

TABBED_PANE_TAB

public static final Region TABBED_PANE_TAB
This specifies the region of a tab of a tabbed pane. This is a subregion of a tabbed pane.

TABBED_PANE_TAB_AREA

public static final Region TABBED_PANE_TAB_AREA
This specifies the region underneath the tabs of a tabbed pane. This is a subregion of a tabbed pane.

TABLE

public static final Region TABLE
Specifies the region of a table.

TABLE_HEADER

public static final Region TABLE_HEADER
Specifies the region of a table header.

TEXT_AREA

public static final Region TEXT_AREA
Specifies the region of a text area.

TEXT_FIELD

public static final Region TEXT_FIELD
Specifies the region of a text field.

TEXT_PANE

public static final Region TEXT_PANE
Specifies the region of a text pane.

TOGGLE_BUTTON

public static final Region TOGGLE_BUTTON
Specifies the region of a toggle button.

TOOL_BAR

public static final Region TOOL_BAR
Specifies the region of a tool bar.

TOOL_BAR_CONTENT

public static final Region TOOL_BAR_CONTENT
Specifies the content region of a tool bar. This is a subregion of a tool bar.

TOOL_BAR_DRAG_WINDOW

public static final Region TOOL_BAR_DRAG_WINDOW
Specifies the drag window region of a tool bar. This is a subregion of a tool bar.

TOOL_BAR_SEPARATOR

public static final Region TOOL_BAR_SEPARATOR
Specifies the region of a separator of a tool bar. This is a subregion of a tool bar.

TOOL_TIP

public static final Region TOOL_TIP
Specifies the region of a tool tip.

TREE

public static final Region TREE
Specifies the region of a tree.

TREE_CELL

public static final Region TREE_CELL
Specifies the region of a tree cell. This is a subregion of a tree.

VIEWPORT

public static final Region VIEWPORT
Specifies the region of a viewport.

Constructor Details

Region

protected Region(String name,
                 String ui,
                 boolean subregion)
Creates a new Region with the specified name and ui ID. The ui must be the same what JComponent.getUIClassID() returns for toplevel regions. For subregions this should be null.
Parameters:
name - the name of the region
ui - the UI class ID of the region or null for subregions
subregion - true if this region is a subregion, false otherwise

Method Details

getName

public String getName()
Returns the name of the region.
Returns:
the name of the region

isSubregion

public boolean isSubregion()
Returns true if this region describes a subregion of a component, false if it describes a component region itself.
Returns:
true if this region describes a subregion of a component, false if it describes a component region itself

toString

public String toString()
Returns the name of the region.
Overrides:
toString in interface Object
Returns:
the name of the region

Region.java -- Describes a region within a component Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.