oracle.ide.inspector.layout

Class PropertyFormLayout

java.lang.Object

oracle.ide.inspector.layout.PropertyFormLayout

All Implemented Interfaces:

Element

Direct Known Subclasses:

PropertyFormLayoutAssembly

public abstract class PropertyFormLayout
extends java.lang.Object
implements Element

A PropertyFormLayout encapsulates the constraints controlling the positioning of PropertyEditors in the property inspector form view.

These contraints are generally specified in the "property-inspectory-hook" of an extension manifest. In general, extension writers do not need to implement this class, a default implementation is provided to unmarshall the layout constraints defined in the extension manifest.

Extension writers that require full control over the property inspector form view layout constraints for a specific PropertyModelmust extend this class and provide their own implementation. The "property-form-layout" information is defined by the XML Schema for the "property-inspector-hook" (propertyInspector-hook.xsd).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTO_EXTEND_PREFERRED_SIZE
static java.lang.String	PROPERTY_FORM_LAYOUT
static java.lang.String	PROPERTY_MODEL_CLASS

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

EXTENDS, ID, PART_OF

Constructor Summary

Constructors

Constructor and Description
PropertyFormLayout()

Method Summary

Modifier and Type	Method and Description
AutoExpandPreferredSize	getAutoExtendPreferredSize()
Extensible	getExtensible() Get the Extensible information.
abstract MetaClass	getPropertyModelClass()
boolean	isExtensible() Find out whether this element is Extensible.
boolean	mayHaveChildren() Find out whether this element contains other elements as children.
java.lang.String	toString()

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

Field Detail

PROPERTY_FORM_LAYOUT

public static final java.lang.String PROPERTY_FORM_LAYOUT

See Also:

Constant Field Values

PROPERTY_MODEL_CLASS

public static final java.lang.String PROPERTY_MODEL_CLASS

See Also:

Constant Field Values

AUTO_EXTEND_PREFERRED_SIZE

public static final java.lang.String AUTO_EXTEND_PREFERRED_SIZE

See Also:

Constant Field Values

Constructor Detail

PropertyFormLayout

public PropertyFormLayout()

Method Detail

getPropertyModelClass

public abstract MetaClass getPropertyModelClass()

Returns:

the property model class this form layout is associated with.

getAutoExtendPreferredSize

public AutoExpandPreferredSize getAutoExtendPreferredSize()

Returns:

the preferred size of this layout when the Property Inspector is displayed "auto-expanded".

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

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

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

Returns:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object