Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD

## org.jvnet.substance.painter.decoration
Enum DecorationAreaType

    java.lang.Object
      java.lang.Enum<DecorationAreaType>
          org.jvnet.substance.painter.decoration.DecorationAreaType

All Implemented Interfaces:
  java.io.Serializable, java.lang.Comparable<DecorationAreaType>

    public enum DecorationAreaType

extends java.lang.Enum<DecorationAreaType>

Enumeration of available decoration area types. This class is part of officially supported API.

Since:
  version 4.3
Author:
  Kirill Grouchnikov

Enum Constant Summary
`FOOTER` Any area that can be placed in the bottom portion of its window.
`GENERAL` Any general area that does not fit for the other types.
`HEADER` Any area that can be placed in the top portion of its window.
`NONE` The default decoration area type.
`PRIMARY_TITLE_PANE` Title pane of top-level windows (frames, dialogs).
`SECONDARY_TITLE_PANE` Title pane of non top-level windows (internal frames, desktop icons).
`TOOLBAR` Tool bar.

Method Summary
`static DecorationAreaType` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static DecorationAreaType[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

### PRIMARY_TITLE_PANE

    public static final DecorationAreaType PRIMARY_TITLE_PANE

  Title pane of top-level windows (frames, dialogs).

### SECONDARY_TITLE_PANE

    public static final DecorationAreaType SECONDARY_TITLE_PANE

  Title pane of non top-level windows (internal frames, desktop icons).

### TOOLBAR

    public static final DecorationAreaType TOOLBAR

  Tool bar.

### HEADER

    public static final DecorationAreaType HEADER

  Any area that can be placed in the top portion of its window. Menu bar is an example of a core Swing component. `JXHeader` and `JXTitledPanel` titled area (components from SwingX suite) are examples of third-party components.

### FOOTER

    public static final DecorationAreaType FOOTER

  Any area that can be placed in the bottom portion of its window. `JXStatusBar` component from SwingX suite is an example of a third-party component.

### GENERAL

    public static final DecorationAreaType GENERAL

  Any general area that does not fit for the other types. `JXTaskPaneContainer` component from SwingX suite is an example of a third-party component.

### NONE

    public static final DecorationAreaType NONE

  The default decoration area type. Components placed in areas with this type do not get any special background decoration painting.

Method Detail

### values

    public static DecorationAreaType[] values()

  Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

      for (DecorationAreaType c : DecorationAreaType.values())
          System.out.println(c);

  Returns:
    an array containing the constants of this enum type, in the order they are declared

### valueOf

    public static DecorationAreaType valueOf(java.lang.String name)

  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

  Parameters:
    `name` - the name of the enum constant to be returned.
  Returns:
    the enum constant with the specified name
  Throws:
    `java.lang.IllegalArgumentException` - if this enum type has no constant with the specified name
    `java.lang.NullPointerException` - if the argument is null

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD