oracle.ide.inspector.layout
Class CategoryLayout

java.lang.Object
  oracle.ide.inspector.layout.ExtensibleElement
      oracle.ide.inspector.layout.CategoryLayout

All Implemented Interfaces:

Identifiable, Element, Extensible

Direct Known Subclasses:

PropertyFormLayoutAssembly.CategoryLayoutAssembly

public abstract class CategoryLayout
extends ExtensibleElement

CategoryLayouts specify how the property inspector form view displays properties under a specific category.

Category layouts are uniquely identified by an ID. The property inspector predefines the "Common" category, identified by this ID: oracle.ide.inspector.category.common. Category IDs are defined in a property model class.

Category layouts organizes property graphical user interfaces in collapsable DisplayGroups and/or ChoiceGroups.

Field Summary

static java.lang.String	CATEGORY_LAYOUT
static java.lang.String	EXPANDED
static java.lang.String	SELECTED

Fields inherited from interface oracle.ide.inspector.layout.Element

EXTENDS, ID, PART_OF

Constructor Summary

CategoryLayout()

Method Summary

abstract java.lang.String	getHint() Get a short helpful hint for user display.
abstract java.lang.String	getTitle() Get the title for user display.
abstract java.lang.Boolean	isExpanded() Get whether the category should be selected by default.
abstract java.lang.Boolean	isSelected() Get whether the category should be selected by default.
java.lang.String	toString()

Methods inherited from class oracle.ide.inspector.layout.ExtensibleElement

getExtensible, isExtensible, mayHaveChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ide.inspector.layout.Element

getChildren

Methods inherited from interface oracle.ide.inspector.layout.Extensible

getBase, getExtends, getPartOf

Methods inherited from interface javax.ide.Identifiable

getID

Field Detail

CATEGORY_LAYOUT

public static final java.lang.String CATEGORY_LAYOUT

See Also:

Constant Field Values

EXPANDED

public static final java.lang.String EXPANDED

See Also:

Constant Field Values

SELECTED

public static final java.lang.String SELECTED

See Also:

Constant Field Values

Constructor Detail

CategoryLayout

public CategoryLayout()

Method Detail

getTitle

public abstract java.lang.String getTitle()

Get the title for user display.

Returns:

the title for user display. Returns an empty string when there is no title available.

getHint

public abstract java.lang.String getHint()

Get a short helpful hint for user display. The hint should guide users as to what to do.

Returns:

a short helpful hint for user display. Returns an empty string when there is no hint available.

isSelected

public abstract java.lang.Boolean isSelected()

Get whether the category should be selected by default.

Returns:

if the category is to be selected by default.

isExpanded

public abstract java.lang.Boolean isExpanded()

Get whether the category should be selected by default. Applicable to the vertical PI only.

Returns:

if the category is to be expanded in the vertical PI, by default.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object