com.ibm.mashups.enabler.model.state
Interface LayoutAccessor

All Superinterfaces:
Accessor

public LayoutAccessor
extends Accessor

Interface representing a LayoutAccessor. Reserved layout container parameters: "templateURL" : the reserved parameter for layout template URL.


Method Summary
 String getTemplateURL()
           Returns the layout template URL (can be used to determine if the state layout is inconsistent with the page instance layout)
 LayoutAccessor setTemplateURL(String url)
           Sets the layout template URL
 LayoutContainerAccessor getContainerAccessor(String containerId)
           Returns the layout container accessor for the specified layout container id in this layout.
 LayoutAccessor removeAll(Array pageWidgets)
           Removes all layout containers and the template URL (can be used to remove obsolete layout's i.e. when the state layout is not the same as the page instance layout)
 

Method Detail

getTemplateURL

String getTemplateURL()
Returns the layout template URL (can be used to determine if the state layout is inconsistent with the page instance layout)

Returns:
A url to the layout's template. Uses dav: endpoint notation, e.g. "dav:filestore/layout-tempates/2ColumnEqual"

setTemplateURL

LayoutAccessor setTemplateURL(String url)
Sets the layout template URL

Parameters:
url - The layout templateURL. Uses dav: endpoint notation, e.g. "dav:filestore/layout-tempates/2ColumnEqual"
Returns:
returns a LayoutAccessor upon success, null upon failure.

getContainerAccessor

LayoutContainerAccessor getContainerAccessor(String containerId)
Returns the layout container accessor for the specified layout container id in this layout. (Note: Possibly non-intinutively Layout contains LayoutContainers.)

Parameters:
containerId - The layout container id for the desired layout container.
Returns:
Returns the specified LayoutContainerAccessor upon success, null upon failure.

removeAll

LayoutAccessor removeAll(Array pageWidgets)
Removes all layout containers and the template URL (can be used to remove obsolete layout's i.e. when the state layout is not the same as the page instance layout)

Parameters:
pageWidgets - Set of widgets on page that if in model should have their size removed. Optional parameter.
Returns:
Returns a LayoutAccessor upon success, null upon failure.


Copyright IBM Corp. 2010 All Rights Reserved.