org.carewebframework.shell.layout

Class UIElementLayout

java.lang.Object

org.carewebframework.shell.layout.UIElementBase

org.carewebframework.shell.layout.UIElementZKBase

org.carewebframework.shell.layout.UIElementLayout

public class UIElementLayout
extends UIElementZKBase

Wrapper for a UI layout component.

Field Summary

Fields inherited from class org.carewebframework.shell.layout.UIElementBase

autoEnable, autoHide, log, maxChildren

Constructor Summary

Constructors

Constructor and Description
UIElementLayout()
UIElementLayout(String layoutName, boolean shared)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterInitialize(boolean deserializing) If this is a linked layout, must deserialize from it.
void	beforeInitialize(boolean deserializing) Subclasses may override this to implement any additional operations that are necessary before this element is initialized (i.e., before property values and parent element are set).
String	getDisplayName() Returns the display name of this element.
UILayout	getLayout()
String	getLayoutName()
boolean	getLinked() Returns the linked state.
Iterable<UIElementBase>	getSerializableChildren() A linked layout has no serializable children.
boolean	getShared()
void	setDefinition(PluginDefinition definition) Sets the plugin definition for this element.
void	setLayoutName(String layoutName)
void	setLinked(boolean linked) Sets the linked state.
void	setShared(boolean shared)

Methods inherited from class org.carewebframework.shell.layout.UIElementZKBase

activate, afterMoveTo, applyColor, applyHint, associateComponent, bind, createFromTemplate, createFromTemplate, createFromTemplate, editProperties, fullSize, getAssociatedUIElement, getEnableDesignModeMask, getInnerComponent, getOuterComponent, getParent, getTemplateUrl, hasVisibleElements, moveChild, setDesignContextMenu, setDesignContextMenu, setDesignMode, setEnableDesignModeMask, setInnerComponent, setOuterComponent, swapChildren, unbind, updateVisibility

Methods inherited from class org.carewebframework.shell.layout.UIElementBase

about, activateChildren, addChild, addChild, afterAddChild, afterParentChanged, afterRemoveChild, applyColor, applyHint, beforeAddChild, beforeParentChanged, beforeRemoveChild, bringToFront, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptChild, canAcceptParent, canAcceptParent, canAcceptParent, canAcceptParent, destroy, findChildElement, getAncestor, getChild, getChild, getChildCount, getChildren, getColor, getDefinition, getEventManager, getFirstChild, getFirstVisibleChild, getHint, getIndex, getInstanceName, getLastChild, getLastVisibleChild, getNextSibling, getPropEditClass, getRejectReason, getRoot, hasAncestor, hasChild, indexOfChild, isActivated, isContainer, isDesignMode, isEnabled, isLocked, isVisible, raise, raise, registerAllowedChildClass, registerAllowedParentClass, remove, removeChild, removeChildren, setColor, setDefinition, setEnabled, setHint, setIndex, setLocked, setParent, setRejectReason, setVisible, updateParentState, updateState, updateVisibility

Methods inherited from class java.lang.Object

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

Constructor Detail

UIElementLayout

public UIElementLayout()

UIElementLayout

public UIElementLayout(String layoutName,
               boolean shared)

Method Detail

setDefinition

public void setDefinition(PluginDefinition definition)

Description copied from class: UIElementBase

Sets the plugin definition for this element.

Overrides:

setDefinition in class UIElementBase

Parameters:

definition - The plugin definition.

getDisplayName

public String getDisplayName()

Description copied from class: UIElementBase

Returns the display name of this element. By default, the definition name is returned, but subclasses may override this to return some other name suitable for display in the design UI.

Overrides:

getDisplayName in class UIElementBase

Returns:

The display name.

getLayout

public UILayout getLayout()
                   throws Exception

Throws:

Exception

getLayoutName

public String getLayoutName()

setLayoutName

public void setLayoutName(String layoutName)

getShared

public boolean getShared()

setShared

public void setShared(boolean shared)

beforeInitialize

public void beforeInitialize(boolean deserializing)
                      throws Exception

Description copied from class: UIElementBase

Subclasses may override this to implement any additional operations that are necessary before this element is initialized (i.e., before property values and parent element are set).

Overrides:

beforeInitialize in class UIElementBase

Parameters:

deserializing - If true, initialization is occurring as a result of deserialization.

Throws:

Exception - Unspecified exception.

afterInitialize

public void afterInitialize(boolean deserializing)
                     throws Exception

If this is a linked layout, must deserialize from it.

Overrides:

afterInitialize in class UIElementBase

Parameters:

deserializing - If true, initialization is occurring as a result of deserialization.

Throws:

Exception - Unspecified exception.

getSerializableChildren

public Iterable<UIElementBase> getSerializableChildren()

A linked layout has no serializable children.

Overrides:

getSerializableChildren in class UIElementBase

Returns:

Iterable of this component's serializable children.

getLinked

public boolean getLinked()

Returns the linked state. If true, the associated layout is linked by reference. Any changes to the layout will be reflected when the containing layout is loaded. If false, the associated layout is embedded. Any changes to the original layout will not be reflected when the containing layout is loaded. Additionally, all child UI elements of a linked layout are locked and may not be modified. Child elements of an embedded layout may be freely edited.

Returns:

The linked state.

setLinked

public void setLinked(boolean linked)

Sets the linked state. A change in this state requires reloading of the associated layout.

Parameters:

linked - The linked state.