Package 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.util.io.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 UnitSettings 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".
  • default.expanded.unit: The unit that will be expanded when WireframeBehavior.expandDefault() is called.
See Also:

  • Constructor Details

    • WireframeSettings

      public WireframeSettings(IPluginConfig config)

  • Method Details

    • 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()