org.carewebframework.shell.layout

Class Layout

java.lang.Object

org.carewebframework.shell.layout.Layout

All Implemented Interfaces:

IClipboardAware<Layout>

public class Layout
extends Object
implements IClipboardAware<Layout>

Represents the layout of the visual interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LAYOUT_VERSION

Constructor Summary

Constructors

Constructor and Description
Layout()
Layout(Layout layout)
Layout(LayoutElement.LayoutRoot root)
Layout(String layoutName)

Method Summary

Modifier and Type	Method and Description
void	clear() Reset the layout to not loaded state.
Layout	fromClipboard(String data) Converts from clipboard format.
String	getName() Returns the name of the currently loaded layout, or null if none loaded.
Class<? extends ElementBase>	getRootClass() Returns the class of the element at the root of the layout.
boolean	isEmpty() Returns true if the layout has no content.
ElementUI	materialize(ElementUI parent) Materializes the layout, under the specified parent, starting from the layout origin.
boolean	saveToProperty(LayoutIdentifier layoutId) Saves the layout as a property value using the specified identifier.
void	setName(String value) Sets the name of the current layout.
String	toClipboard() Converts to clipboard format.
String	toString() Returns the layout as an xml-formatted string.

Methods inherited from class java.lang.Object

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

Field Detail

LAYOUT_VERSION

public static final String LAYOUT_VERSION

See Also:

Constant Field Values

Constructor Detail

Layout

public Layout()

Layout

public Layout(Layout layout)

Layout

public Layout(String layoutName)

Layout

public Layout(LayoutElement.LayoutRoot root)

Method Detail

materialize

public ElementUI materialize(ElementUI parent)

Materializes the layout, under the specified parent, starting from the layout origin.

Parameters:

parent - Parent UI element at this level of the hierarchy. May be null.

Returns:

The UI element created during this pass.

getName

public String getName()

Returns the name of the currently loaded layout, or null if none loaded.

Returns:

The layout name.

setName

public void setName(String value)

Sets the name of the current layout.

Parameters:

value - New name for the layout.

clear

public void clear()

Reset the layout to not loaded state.

saveToProperty

public boolean saveToProperty(LayoutIdentifier layoutId)

Saves the layout as a property value using the specified identifier.

Parameters:

layoutId - Layout identifier

Returns:

True if operation succeeded.

getRootClass

public Class<? extends ElementBase> getRootClass()

Returns the class of the element at the root of the layout.

Returns:

Class of the element at the root of the layout, or null if none.

isEmpty

public boolean isEmpty()

Returns true if the layout has no content.

Returns:

True if the layout has no content.

toString

public String toString()

Returns the layout as an xml-formatted string.

Overrides:

toString in class Object

toClipboard

public String toClipboard()

Converts to clipboard format.

Specified by:

toClipboard in interface IClipboardAware<Layout>

Returns:

String format

fromClipboard

public Layout fromClipboard(String data)

Converts from clipboard format.

Specified by:

fromClipboard in interface IClipboardAware<Layout>

Parameters:

data - String data from clipboard.

Returns:

Instance of original class.