org.hippoecm.frontend.plugins.yui.layout

Class WireframeSettings

java.lang.Object

org.hippoecm.frontend.plugins.yui.AjaxSettings

org.hippoecm.frontend.plugins.yui.layout.WireframeSettings

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, IAjaxSettings

public class WireframeSettings
extends AjaxSettings

Contains all settings of a wireframe and it's units.

• ROOT_ID: a YuiId value representing the wireframe's root element.
• PARENT_ID: a YuiId value representing the parent wireframe (value will be auto-set by the WireframeBehavior when LINKED_WITH_PARENT is true.
• LINKED_WITH_PARENT: when set to true, the wireframe will register itself with it's parent wireframe and sync render and resize events.
• UNITS: Array of representing the units for this wireframe. These should be set by the same IPluginConfig object as the WireframeSettings.
  The easiest way to configure units is storing the html and configuration all in the same place as the wireframe's html and configuration. If we use an IPluginConfig for configuration, we can add a StringArray property and add the positional name of the units we'd like to add: for example "top" and "center". This will cause the WireframeSettings to lookup two String properties on the IPluginConfig named "top" and "center" which should contain a comma-separated string of UnitSettings, like "id=center,scroll=true,width=120".

Warning: this class currently extends the YuiObject which is deprecated and will soon be replaced by a POJO settings file. Not sure how to handle default values and things like dont-escape-string yet.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WireframeSettings(IPluginConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
String	getClientClassName()
String	getDefaultExpandedUnit()
YuiId	getParentId()
YuiId	getRootId()
UnitSettings	getUnit(String position)
List<UnitSettings>	getUnits()
boolean	hasExpandedUnit()
boolean	isLinkedWithParent()
void	setClientClassName(String clientClassName)
void	setDefaultExpandedUnit(String defaultExpandedUnit)
void	setLinkedWithParent(boolean linkedWithParent)
void	setMarkupId(String markupId)
void	setParentId(YuiId parentId)

Methods inherited from class org.hippoecm.frontend.plugins.yui.AjaxSettings

getCallbackFunction, getCallbackParameters, getCallbackUrl, setCallbackFunction, setCallbackParameters, setCallbackUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

WireframeSettings

public WireframeSettings(IPluginConfig config)

Method Detail

getClientClassName

public String getClientClassName()

setClientClassName

public void setClientClassName(String clientClassName)

setMarkupId

public void setMarkupId(String markupId)

getRootId

public YuiId getRootId()

setParentId

public void setParentId(YuiId parentId)

getParentId

public YuiId getParentId()

setLinkedWithParent

public void setLinkedWithParent(boolean linkedWithParent)

isLinkedWithParent

public boolean isLinkedWithParent()

getUnits

public List<UnitSettings> getUnits()

getUnit

public UnitSettings getUnit(String position)

getDefaultExpandedUnit

public String getDefaultExpandedUnit()

setDefaultExpandedUnit

public void setDefaultExpandedUnit(String defaultExpandedUnit)

hasExpandedUnit

public boolean hasExpandedUnit()