Liking cljdoc? Tell your friends :D

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.

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"/>

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.

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"/>
raw docstring

*-arrow-buttonclj

Static Constant.

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.

type: javax.swing.plaf.synth.Region

Static Constant.

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.

type: javax.swing.plaf.synth.Region
raw docstring

*-buttonclj

Static Constant.

Button region. To bind a style to this Region use the name Button.

type: javax.swing.plaf.synth.Region

Static Constant.

Button region. To bind a style to this Region use the name
 Button.

type: javax.swing.plaf.synth.Region
raw docstring

*-check-boxclj

Static Constant.

CheckBox region. To bind a style to this Region use the name CheckBox.

type: javax.swing.plaf.synth.Region

Static Constant.

CheckBox region. To bind a style to this Region use the name
 CheckBox.

type: javax.swing.plaf.synth.Region
raw docstring

*-check-box-menu-itemclj

Static Constant.

CheckBoxMenuItem region. To bind a style to this Region use the name CheckBoxMenuItem.

type: javax.swing.plaf.synth.Region

Static Constant.

CheckBoxMenuItem region. To bind a style to this Region use
 the name CheckBoxMenuItem.

type: javax.swing.plaf.synth.Region
raw docstring

*-color-chooserclj

Static Constant.

ColorChooser region. To bind a style to this Region use the name ColorChooser.

type: javax.swing.plaf.synth.Region

Static Constant.

ColorChooser region. To bind a style to this Region use
 the name ColorChooser.

type: javax.swing.plaf.synth.Region
raw docstring

*-combo-boxclj

Static Constant.

ComboBox region. To bind a style to this Region use the name ComboBox.

type: javax.swing.plaf.synth.Region

Static Constant.

ComboBox region. To bind a style to this Region use
 the name ComboBox.

type: javax.swing.plaf.synth.Region
raw docstring

*-desktop-iconclj

Static Constant.

DesktopIcon region. To bind a style to this Region use the name DesktopIcon.

type: javax.swing.plaf.synth.Region

Static Constant.

DesktopIcon region. To bind a style to this Region use
 the name DesktopIcon.

type: javax.swing.plaf.synth.Region
raw docstring

*-desktop-paneclj

Static Constant.

DesktopPane region. To bind a style to this Region use the name DesktopPane.

type: javax.swing.plaf.synth.Region

Static Constant.

DesktopPane region. To bind a style to this Region use
 the name DesktopPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-editor-paneclj

Static Constant.

EditorPane region. To bind a style to this Region use the name EditorPane.

type: javax.swing.plaf.synth.Region

Static Constant.

EditorPane region. To bind a style to this Region use
 the name EditorPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-file-chooserclj

Static Constant.

FileChooser region. To bind a style to this Region use the name FileChooser.

type: javax.swing.plaf.synth.Region

Static Constant.

FileChooser region. To bind a style to this Region use
 the name FileChooser.

type: javax.swing.plaf.synth.Region
raw docstring

*-formatted-text-fieldclj

Static Constant.

FormattedTextField region. To bind a style to this Region use the name FormattedTextField.

type: javax.swing.plaf.synth.Region

Static Constant.

FormattedTextField region. To bind a style to this Region use
 the name FormattedTextField.

type: javax.swing.plaf.synth.Region
raw docstring

*-internal-frameclj

Static Constant.

InternalFrame region. To bind a style to this Region use the name InternalFrame.

type: javax.swing.plaf.synth.Region

Static Constant.

InternalFrame region. To bind a style to this Region use
 the name InternalFrame.

type: javax.swing.plaf.synth.Region
raw docstring

*-internal-frame-title-paneclj

Static Constant.

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.

type: javax.swing.plaf.synth.Region

Static Constant.

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.

type: javax.swing.plaf.synth.Region
raw docstring

*-labelclj

Static Constant.

Label region. To bind a style to this Region use the name Label.

type: javax.swing.plaf.synth.Region

Static Constant.

Label region. To bind a style to this Region use the name
 Label.

type: javax.swing.plaf.synth.Region
raw docstring

*-listclj

Static Constant.

List region. To bind a style to this Region use the name List.

type: javax.swing.plaf.synth.Region

Static Constant.

List region. To bind a style to this Region use the name
 List.

type: javax.swing.plaf.synth.Region
raw docstring

*-menuclj

Static Constant.

Menu region. To bind a style to this Region use the name Menu.

type: javax.swing.plaf.synth.Region

Static Constant.

Menu region. To bind a style to this Region use the name
 Menu.

type: javax.swing.plaf.synth.Region
raw docstring

*-menu-barclj

Static Constant.

MenuBar region. To bind a style to this Region use the name MenuBar.

type: javax.swing.plaf.synth.Region

Static Constant.

MenuBar region. To bind a style to this Region use the name
 MenuBar.

type: javax.swing.plaf.synth.Region
raw docstring

*-menu-itemclj

Static Constant.

MenuItem region. To bind a style to this Region use the name MenuItem.

type: javax.swing.plaf.synth.Region

Static Constant.

MenuItem region. To bind a style to this Region use the name
 MenuItem.

type: javax.swing.plaf.synth.Region
raw docstring

*-menu-item-acceleratorclj

Static Constant.

Accelerator region of a MenuItem. To bind a style to this Region use the name MenuItemAccelerator.

type: javax.swing.plaf.synth.Region

Static Constant.

Accelerator region of a MenuItem. To bind a style to this
 Region use the name MenuItemAccelerator.

type: javax.swing.plaf.synth.Region
raw docstring

*-option-paneclj

Static Constant.

OptionPane region. To bind a style to this Region use the name OptionPane.

type: javax.swing.plaf.synth.Region

Static Constant.

OptionPane region. To bind a style to this Region use
 the name OptionPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-panelclj

Static Constant.

Panel region. To bind a style to this Region use the name Panel.

type: javax.swing.plaf.synth.Region

Static Constant.

Panel region. To bind a style to this Region use the name
 Panel.

type: javax.swing.plaf.synth.Region
raw docstring

*-password-fieldclj

Static Constant.

PasswordField region. To bind a style to this Region use the name PasswordField.

type: javax.swing.plaf.synth.Region

Static Constant.

PasswordField region. To bind a style to this Region use
 the name PasswordField.

type: javax.swing.plaf.synth.Region
raw docstring

*-popup-menuclj

Static Constant.

PopupMenu region. To bind a style to this Region use the name PopupMenu.

type: javax.swing.plaf.synth.Region

Static Constant.

PopupMenu region. To bind a style to this Region use
 the name PopupMenu.

type: javax.swing.plaf.synth.Region
raw docstring

*-popup-menu-separatorclj

Static Constant.

PopupMenuSeparator region. To bind a style to this Region use the name PopupMenuSeparator.

type: javax.swing.plaf.synth.Region

Static Constant.

PopupMenuSeparator region. To bind a style to this Region
 use the name PopupMenuSeparator.

type: javax.swing.plaf.synth.Region
raw docstring

*-progress-barclj

Static Constant.

ProgressBar region. To bind a style to this Region use the name ProgressBar.

type: javax.swing.plaf.synth.Region

Static Constant.

ProgressBar region. To bind a style to this Region
 use the name ProgressBar.

type: javax.swing.plaf.synth.Region
raw docstring

*-radio-buttonclj

Static Constant.

RadioButton region. To bind a style to this Region use the name RadioButton.

type: javax.swing.plaf.synth.Region

Static Constant.

RadioButton region. To bind a style to this Region
 use the name RadioButton.

type: javax.swing.plaf.synth.Region
raw docstring

*-radio-button-menu-itemclj

Static Constant.

RegionButtonMenuItem region. To bind a style to this Region use the name RadioButtonMenuItem.

type: javax.swing.plaf.synth.Region

Static Constant.

RegionButtonMenuItem region. To bind a style to this Region
 use the name RadioButtonMenuItem.

type: javax.swing.plaf.synth.Region
raw docstring

*-root-paneclj

Static Constant.

RootPane region. To bind a style to this Region use the name RootPane.

type: javax.swing.plaf.synth.Region

Static Constant.

RootPane region. To bind a style to this Region use
 the name RootPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-scroll-barclj

Static Constant.

ScrollBar region. To bind a style to this Region use the name ScrollBar.

type: javax.swing.plaf.synth.Region

Static Constant.

ScrollBar region. To bind a style to this Region use
 the name ScrollBar.

type: javax.swing.plaf.synth.Region
raw docstring

*-scroll-bar-thumbclj

Static Constant.

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.

type: javax.swing.plaf.synth.Region

Static Constant.

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.

type: javax.swing.plaf.synth.Region
raw docstring

*-scroll-bar-trackclj

Static Constant.

Track of the ScrollBar. To bind a style to this Region use the name ScrollBarTrack.

type: javax.swing.plaf.synth.Region

Static Constant.

Track of the ScrollBar. To bind a style to this Region use
 the name ScrollBarTrack.

type: javax.swing.plaf.synth.Region
raw docstring

*-scroll-paneclj

Static Constant.

ScrollPane region. To bind a style to this Region use the name ScrollPane.

type: javax.swing.plaf.synth.Region

Static Constant.

ScrollPane region. To bind a style to this Region use
 the name ScrollPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-separatorclj

Static Constant.

Separator region. To bind a style to this Region use the name Separator.

type: javax.swing.plaf.synth.Region

Static Constant.

Separator region. To bind a style to this Region use
 the name Separator.

type: javax.swing.plaf.synth.Region
raw docstring

*-sliderclj

Static Constant.

Slider region. To bind a style to this Region use the name Slider.

type: javax.swing.plaf.synth.Region

Static Constant.

Slider region. To bind a style to this Region use
 the name Slider.

type: javax.swing.plaf.synth.Region
raw docstring

*-slider-thumbclj

Static Constant.

Thumb of the Slider. The thumb of the Slider identifies the current value. To bind a style to this Region use the name SliderThumb.

type: javax.swing.plaf.synth.Region

Static Constant.

Thumb of the Slider. The thumb of the Slider identifies the current
 value. To bind a style to this Region use the name
 SliderThumb.

type: javax.swing.plaf.synth.Region
raw docstring

*-slider-trackclj

Static Constant.

Track of the Slider. To bind a style to this Region use the name SliderTrack.

type: javax.swing.plaf.synth.Region

Static Constant.

Track of the Slider. To bind a style to this Region use
 the name SliderTrack.

type: javax.swing.plaf.synth.Region
raw docstring

*-spinnerclj

Static Constant.

Spinner region. To bind a style to this Region use the name Spinner.

type: javax.swing.plaf.synth.Region

Static Constant.

Spinner region. To bind a style to this Region use the name
 Spinner.

type: javax.swing.plaf.synth.Region
raw docstring

*-split-paneclj

Static Constant.

SplitPane region. To bind a style to this Region use the name SplitPane.

type: javax.swing.plaf.synth.Region

Static Constant.

SplitPane region. To bind a style to this Region use the name
 SplitPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-split-pane-dividerclj

Static Constant.

Divider of the SplitPane. To bind a style to this Region use the name SplitPaneDivider.

type: javax.swing.plaf.synth.Region

Static Constant.

Divider of the SplitPane. To bind a style to this Region
 use the name SplitPaneDivider.

type: javax.swing.plaf.synth.Region
raw docstring

*-tabbed-paneclj

Static Constant.

TabbedPane region. To bind a style to this Region use the name TabbedPane.

type: javax.swing.plaf.synth.Region

Static Constant.

TabbedPane region. To bind a style to this Region use
 the name TabbedPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-tabbed-pane-contentclj

Static Constant.

Region of a TabbedPane containing the content. To bind a style to this Region use the name TabbedPaneContent.

type: javax.swing.plaf.synth.Region

Static Constant.

Region of a TabbedPane containing the content. To bind a style to this
 Region use the name TabbedPaneContent.

type: javax.swing.plaf.synth.Region
raw docstring

*-tabbed-pane-tabclj

Static Constant.

Region of a TabbedPane for one tab. To bind a style to this Region use the name TabbedPaneTab.

type: javax.swing.plaf.synth.Region

Static Constant.

Region of a TabbedPane for one tab. To bind a style to this
 Region use the name TabbedPaneTab.

type: javax.swing.plaf.synth.Region
raw docstring

*-tabbed-pane-tab-areaclj

Static Constant.

Region of a TabbedPane containing the tabs. To bind a style to this Region use the name TabbedPaneTabArea.

type: javax.swing.plaf.synth.Region

Static Constant.

Region of a TabbedPane containing the tabs. To bind a style to this
 Region use the name TabbedPaneTabArea.

type: javax.swing.plaf.synth.Region
raw docstring

*-tableclj

Static Constant.

Table region. To bind a style to this Region use the name Table.

type: javax.swing.plaf.synth.Region

Static Constant.

Table region. To bind a style to this Region use
 the name Table.

type: javax.swing.plaf.synth.Region
raw docstring

*-table-headerclj

Static Constant.

TableHeader region. To bind a style to this Region use the name TableHeader.

type: javax.swing.plaf.synth.Region

Static Constant.

TableHeader region. To bind a style to this Region use
 the name TableHeader.

type: javax.swing.plaf.synth.Region
raw docstring

*-text-areaclj

Static Constant.

TextArea region. To bind a style to this Region use the name TextArea.

type: javax.swing.plaf.synth.Region

Static Constant.

TextArea region. To bind a style to this Region use
 the name TextArea.

type: javax.swing.plaf.synth.Region
raw docstring

*-text-fieldclj

Static Constant.

TextField region. To bind a style to this Region use the name TextField.

type: javax.swing.plaf.synth.Region

Static Constant.

TextField region. To bind a style to this Region use
 the name TextField.

type: javax.swing.plaf.synth.Region
raw docstring

*-text-paneclj

Static Constant.

TextPane region. To bind a style to this Region use the name TextPane.

type: javax.swing.plaf.synth.Region

Static Constant.

TextPane region. To bind a style to this Region use
 the name TextPane.

type: javax.swing.plaf.synth.Region
raw docstring

*-toggle-buttonclj

Static Constant.

ToggleButton region. To bind a style to this Region use the name ToggleButton.

type: javax.swing.plaf.synth.Region

Static Constant.

ToggleButton region. To bind a style to this Region use
 the name ToggleButton.

type: javax.swing.plaf.synth.Region
raw docstring

*-tool-barclj

Static Constant.

ToolBar region. To bind a style to this Region use the name ToolBar.

type: javax.swing.plaf.synth.Region

Static Constant.

ToolBar region. To bind a style to this Region use
 the name ToolBar.

type: javax.swing.plaf.synth.Region
raw docstring

*-tool-bar-contentclj

Static Constant.

Region of the ToolBar containing the content. To bind a style to this Region use the name ToolBarContent.

type: javax.swing.plaf.synth.Region

Static Constant.

Region of the ToolBar containing the content. To bind a style to this
 Region use the name ToolBarContent.

type: javax.swing.plaf.synth.Region
raw docstring

*-tool-bar-drag-windowclj

Static Constant.

Region for the Window containing the ToolBar. To bind a style to this Region use the name ToolBarDragWindow.

type: javax.swing.plaf.synth.Region

Static Constant.

Region for the Window containing the ToolBar. To bind a style to this
 Region use the name ToolBarDragWindow.

type: javax.swing.plaf.synth.Region
raw docstring

*-tool-bar-separatorclj

Static Constant.

ToolBar separator region. To bind a style to this Region use the name ToolBarSeparator.

type: javax.swing.plaf.synth.Region

Static Constant.

ToolBar separator region. To bind a style to this Region use
 the name ToolBarSeparator.

type: javax.swing.plaf.synth.Region
raw docstring

*-tool-tipclj

Static Constant.

ToolTip region. To bind a style to this Region use the name ToolTip.

type: javax.swing.plaf.synth.Region

Static Constant.

ToolTip region. To bind a style to this Region use
 the name ToolTip.

type: javax.swing.plaf.synth.Region
raw docstring

*-treeclj

Static Constant.

Tree region. To bind a style to this Region use the name Tree.

type: javax.swing.plaf.synth.Region

Static Constant.

Tree region. To bind a style to this Region use the name
 Tree.

type: javax.swing.plaf.synth.Region
raw docstring

*-tree-cellclj

Static Constant.

Region of the Tree for one cell. To bind a style to this Region use the name TreeCell.

type: javax.swing.plaf.synth.Region

Static Constant.

Region of the Tree for one cell. To bind a style to this
 Region use the name TreeCell.

type: javax.swing.plaf.synth.Region
raw docstring

*-viewportclj

Static Constant.

Viewport region. To bind a style to this Region use the name Viewport.

type: javax.swing.plaf.synth.Region

Static Constant.

Viewport region. To bind a style to this Region use
 the name Viewport.

type: javax.swing.plaf.synth.Region
raw docstring

get-nameclj

(get-name this)

Returns the name of the region.

returns: name of the Region. - java.lang.String

Returns the name of the region.

returns: name of the Region. - `java.lang.String`
raw docstring

subregion?clj

(subregion? this)

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. - boolean

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. - `boolean`
raw docstring

to-stringclj

(to-string this)

Returns the name of the Region.

returns: name of the Region. - java.lang.String

Returns the name of the Region.

returns: name of the Region. - `java.lang.String`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close