public interface Layout extends Serializable
A layout is a group of Widget
instances, built from a LayoutDefinition
in a given mode.
Modifier and Type | Method and Description |
---|---|
int |
getColumns()
Returns the maximum number of columns.
|
LayoutDefinition |
getDefinition()
Returns the definition from which this layout instance was generated.
|
String |
getDevTemplate()
Returns the template to use for dev mode.
|
String |
getId()
Returns the layout id, unique within the facelet context.
|
String |
getMode()
Returns the layout mode.
|
String |
getName()
Returns the layout name used to identify it within the layout service.
|
Map<String,Serializable> |
getProperties()
Get properties to use in this mode.
|
Serializable |
getProperty(String name)
Returns property with given name in this mode.
|
LayoutRow[] |
getRows()
Returns the table of widgets.
|
String |
getTagConfigId()
Returns the unique identifier of this widget to be used in tag configuration.
|
String |
getTemplate()
Returns the template used to render widgets.
|
String |
getType()
Returns the layout type.
|
String |
getTypeCategory()
Returns the layout type category.
|
String |
getValueName()
Gets the value name used to compute widget attributes.
|
Widget |
getWidget(String name)
Returns widget with given name.
|
Map<String,Widget> |
getWidgetMap()
Returns a widget map, with widget name as key.
|
boolean |
isDynamic()
Return true if this layout was generated from configuration on a service, and not generated on-the-fly using
dynamic behaviors.
|
void |
setId(String id)
Sets the layout id, unique within the facelet context.
|
void |
setProperty(String name,
Serializable value)
Sets property with given name on the layout.
|
void |
setValueName(String valueName)
Sets the value name used to compute widget bindings.
|
String getTagConfigId()
In JSF, layouts are rendered dynamically and re-use the tag configuration of the tag rendering them when adding handlers to the facelet hierarchy. Since this tag identifier is used to perform some kind of caching on the JSF layer, it needs to change when the layout definition changes, so that JSF components are not mistaken for another one.
This identifier is unique to a given layout definition and always returns the same result given the same layout definition.
String getTypeCategory()
String getTemplate()
LayoutRow[] getRows()
This list is computed from the LayoutDefinition
rows.
Widgets that are not found are ignored.
int getColumns()
Widget getWidget(String name)
Only widgets of the first level are retrieved.
Map<String,Widget> getWidgetMap()
Only widgets of the first level are retrieved.
Map<String,Serializable> getProperties()
The way that properties will be mapped to rendered components is managed by the widget type.
Serializable getProperty(String name)
name
- the property name.void setProperty(String name, Serializable value)
name
- the property name.value
- the property value or null if not found.String getValueName()
void setValueName(String valueName)
boolean isDynamic()
String getDevTemplate()
Is retrieved from layout definition templates, or from layout type templates, using the BuiltinModes.DEV
.
LayoutDefinition getDefinition()
Useful in dev mode to show the corresponding configuration in the UI.
Copyright © 2015 Nuxeo SA. All rights reserved.