UILayout (CareWeb Framework Shell 4.0.5 API)

java.lang.Object
- org.carewebframework.shell.layout.UILayout

All Implemented Interfaces:

IClipboardAware<UILayout>, IPropertyProvider
```
public class UILayout
extends Object
implements IPropertyProvider, IClipboardAware<UILayout>
```
Represents the layout of the visual interface.

Constructor Summary

Constructors
Constructor and Description

UILayout()

Constructors
Constructor and Description
`UILayout()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the current document.
`UIElementBase`	`deserialize(UIElementBase parent)` Deserializes the layout, under the specified parent, starting from the layout origin.
`UILayout`	`fromClipboard(String data)` Converts from clipboard format.
`String`	`getName()` Returns the name of the currently loaded layout, or null if none loaded.
`String`	`getObjectName()` Returns the object name (i.e., the element tag) of the currently selected node.
`String`	`getProperty(String key)` Returns a property value as a string.
`Class<? extends UIElementBase>`	`getRootClass()` Returns the class of the element at the root of the layout.
`String`	`getVersion()` Returns the version of the layout.
`boolean`	`hasProperty(String name)` Returns true if the specified attribute exists in the current node.
`boolean`	`isEmpty()` Returns true if the layout has no content.
`UILayout`	`loadByAppId(String appId)` Load the layout associated with the specified application id.
`UILayout`	`loadFromProperty(LayoutIdentifier layoutId)` Load the layout from a stored property.
`void`	`loadFromResource(String resource)` Loads a layout from the specified resource.
`UILayout`	`loadFromText(String text)` Load the layout from a string.
`void`	`loadFromUrl(String url)` Load the layout from a file.
`boolean`	`moveDown()` Move current node down one level.
`boolean`	`moveNext()` Moves to next sibling node.
`boolean`	`moveTop()` Move to the top element in the document.
`boolean`	`moveUp()` Move up one level.
`void`	`newChild(String name)` Create a new element node as the child of the current node and make it the current node.
`boolean`	`readBoolean(String name, boolean deflt)` Returns value of named attribute as a boolean.
`int`	`readInteger(String name, int deflt)` Return value of named attribute as an integer;
`String`	`readString(String name, String deflt)` Return value of named attribute as a string.
`boolean`	`saveToProperty(LayoutIdentifier layoutId)` Saves the layout as a property value using the specified identifier.
`static UILayout`	`serialize(UIElementBase parent)` Serializes the UI element hierarchy under and including the specified element.
`void`	`setName(String value)` Sets the name of the current layout.
`void`	`setVersion(String value)` Sets the version of the current layout.
`String`	`toClipboard()` Converts to clipboard format.
`String`	`toString()` Returns the layout as an xml-formatted string.
`void`	`writeBoolean(String name, boolean value)`
`void`	`writeInteger(String name, int value)`
`void`	`writeString(String name, String value)` Sets an attribute value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UILayout
```
public UILayout()
```
- Method Detail
  - serialize
```
public static UILayout serialize(UIElementBase parent)
                          throws Exception
```
    Serializes the UI element hierarchy under and including the specified element.
    
    Parameters:
    parent - Top level element to be serialized.
    
    Returns:
    A UI layout representing the serialized hierarchy.
    
    Throws:
    
    Exception - Unspecified exception.
  - deserialize
```
public UIElementBase deserialize(UIElementBase parent)
                          throws Exception
```
    Deserializes 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.
    
    Throws:
    
    Exception - Unspecified exception.
  - getObjectName
```
public String getObjectName()
```
    Returns the object name (i.e., the element tag) of the currently selected node.
    
    Returns:
    The object name.
  - 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.
  - getVersion
```
public String getVersion()
```
    Returns the version of the layout.
    
    Returns:
    The layout version.
  - setVersion
```
public void setVersion(String value)
```
    Sets the version of the current layout.
    
    Parameters:
    value - Version of the layout.
  - loadFromResource
```
public void loadFromResource(String resource)
                      throws Exception
```
    Loads a layout from the specified resource.
    
    Parameters:
    resource - URL of the resource containing the layout configuration.
    If url of format "app:xxx", then layout associated with application id "xxx" is loaded.
    If url of format "shared:xxx", then shared layout named "xxx" is loaded.
    If url of format "private:xxx", then user layout named "xxx" is loaded.
    Otherwise, resource is assumed to be a resource url.
    
    Throws:
    
    Exception - Unspecified exception.
  - loadFromUrl
```
public void loadFromUrl(String url)
                 throws Exception
```
    Load the layout from a file.
    
    Parameters:
    url - Resource path.
    
    Throws:
    
    Exception - when problem retrieving resource via url.
  - loadFromText
```
public UILayout loadFromText(String text)
                      throws Exception
```
    Load the layout from a string.
    
    Parameters:
    text - The XML text to parse.
    
    Returns:
    This layout (for chaining).
    
    Throws:
    
    Exception - Unspecified exception.
  - loadFromProperty
```
public UILayout loadFromProperty(LayoutIdentifier layoutId)
                          throws Exception
```
    Load the layout from a stored property.
    
    Parameters:
    layoutId - Layout identifier.
    
    Returns:
    This layout (for chaining).
    
    Throws:
    
    Exception - Unspecified exception.
  - loadByAppId
```
public UILayout loadByAppId(String appId)
                     throws Exception
```
    Load the layout associated with the specified application id.
    
    Parameters:
    appId - An application id.
    
    Returns:
    True if the operation succeeded.
    
    Throws:
    
    Exception - Unspecified exception.
  - 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.
  - clear
```
public void clear()
```
    Clears the current document.
  - getRootClass
```
public Class<? extends UIElementBase> 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.
  - moveDown
```
public boolean moveDown()
```
    Move current node down one level.
    
    Returns:
    True if successful.
  - moveNext
```
public boolean moveNext()
```
    Moves to next sibling node.
    
    Returns:
    True if successful.
  - moveTop
```
public boolean moveTop()
```
    Move to the top element in the document.
    
    Returns:
    Returns true only if a layout is currently loaded.
  - moveUp
```
public boolean moveUp()
```
    Move up one level.
    
    Returns:
    True if successful
  - readBoolean
```
public boolean readBoolean(String name,
                  boolean deflt)
```
    Returns value of named attribute as a boolean.
    
    Parameters:
    name - Attribute name.
    deflt - Default value if not found.
    
    Returns:
    Value of the attribute.
  - readInteger
```
public int readInteger(String name,
              int deflt)
```
    Return value of named attribute as an integer;
    
    Parameters:
    name - Attribute name.
    deflt - Default value if not found.
    
    Returns:
    Value of the attribute.
  - readString
```
public String readString(String name,
                String deflt)
```
    Return value of named attribute as a string.
    
    Parameters:
    name - Attribute name.
    deflt - Default value if not found.
    
    Returns:
    Value of the attribute.
  - newChild
```
public void newChild(String name)
```
    Create a new element node as the child of the current node and make it the current node.
    
    Parameters:
    name - Tag name for the new element.
  - writeBoolean
```
public void writeBoolean(String name,
                boolean value)
```
  - writeInteger
```
public void writeInteger(String name,
                int value)
```
  - writeString
```
public void writeString(String name,
               String value)
```
    Sets an attribute value.
    
    Parameters:
    name - Attribute name.
    value - Attribute value.
  - 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
  - getProperty
```
public String getProperty(String key)
```
    Description copied from interface: IPropertyProvider
    
    Returns a property value as a string.
    
    Specified by:
    
    getProperty in interface IPropertyProvider
    
    Parameters:
    key - Name of the property whose value is sought.
    
    Returns:
    The property's value, or null if not found.
    See Also:
    IPropertyProvider.getProperty(String)
  - hasProperty
```
public boolean hasProperty(String name)
```
    Returns true if the specified attribute exists in the current node.
    
    Specified by:
    
    hasProperty in interface IPropertyProvider
    
    Parameters:
    name - Attribute name.
    
    Returns:
    True if the attribute exists.
  - toClipboard
```
public String toClipboard()
```
    Converts to clipboard format.
    
    Specified by:
    
    toClipboard in interface IClipboardAware<UILayout>
    
    Returns:
    String format
  - fromClipboard
```
public UILayout fromClipboard(String data)
                       throws Exception
```
    Converts from clipboard format.
    
    Specified by:
    
    fromClipboard in interface IClipboardAware<UILayout>
    
    Parameters:
    data - String data from clipboard.
    
    Returns:
    Instance of original class.
    
    Throws:
    
    Exception - Unspecified exception.

Class UILayout

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UILayout

Method Detail

serialize

deserialize

getObjectName

getName

setName

getVersion

setVersion

loadFromResource

loadFromUrl

loadFromText

loadFromProperty

loadByAppId

saveToProperty

clear

getRootClass

moveDown

moveNext

moveTop

moveUp

readBoolean

readInteger

readString

newChild

writeBoolean

writeInteger

writeString

isEmpty

toString

getProperty

hasProperty

toClipboard

fromClipboard