oracle.ide.inspector.layout
Class ExtensibleGroup

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

All Implemented Interfaces:

Identifiable, Element, Extensible

Direct Known Subclasses:

Choice, ChoiceGroup, DisplayGroup

public abstract class ExtensibleGroup
extends ExtensibleElement

Group elements that are also extensible must implement this interface. For example, the ChoiceGroup is an extensible group that implements this interface.

Field Summary

static java.lang.String	EXPANDED
static java.lang.String	HINT
static java.lang.String	TITLE

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

EXTENDS, ID, PART_OF

Constructor Summary

ExtensibleGroup()

Method Summary

abstract ExtensibleGroup	getBase() Get the base element.
Extensible	getExtensible() Get the Extensible information.
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 boolean	isExpanded() Groups collect a number of displayable elements into meaningful groups that are hidden from view when the group is not in its expanded state.
boolean	isExtensible() Find out whether this element is Extensible.
boolean	mayHaveChildren() Find out whether this element contains other elements as children.

Methods inherited from class java.lang.Object

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

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

getChildren

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

getExtends, getPartOf

Methods inherited from interface javax.ide.Identifiable

getID

Field Detail

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

HINT

public static final java.lang.String HINT

See Also:

Constant Field Values

EXPANDED

public static final java.lang.String EXPANDED

See Also:

Constant Field Values

Constructor Detail

ExtensibleGroup

public ExtensibleGroup()

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.

isExpanded

public abstract boolean isExpanded()

Groups collect a number of displayable elements into meaningful groups that are hidden from view when the group is not in its expanded state.

Call this method to determine the initial state of the display group.

Returns:

the initial expanded state of the display group. If the initial state was not specified in the extension manifest, this method returns true.

getBase

public abstract ExtensibleGroup getBase()

Get the base element. The base element is the extensible group element being extended by this extensible group.

Returns:

the base element.

mayHaveChildren

public boolean mayHaveChildren()

Description copied from interface: Element

Find out whether this element contains other elements as children.

Specified by:

mayHaveChildren in interface Element

Overrides:

mayHaveChildren in class ExtensibleElement

Returns:

true is this element is a container of other elements.

isExtensible

public boolean isExtensible()

Description copied from interface: Element

Find out whether this element is Extensible.

Specified by:

isExtensible in interface Element

Overrides:

isExtensible in class ExtensibleElement

Returns:

true if this element is Extensible.

getExtensible

public Extensible getExtensible()

Description copied from interface: Element

Get the Extensible information.

Specified by:

getExtensible in interface Element

Overrides:

getExtensible in class ExtensibleElement

Returns:

implementations that return true from the isExtensible() method, must implement the Extensible interface and return this from their implementation of this method.