|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.runtime.model.DefaultComponent org.nuxeo.ecm.platform.forms.layout.service.WebLayoutManagerImpl
public class WebLayoutManagerImpl
Layout service implementation.
Field Summary | |
---|---|
static String |
LAYOUTS_EP_NAME
|
static ComponentName |
NAME
|
static String |
WIDGET_TYPES_EP_NAME
|
static String |
WIDGETS_EP_NAME
|
Constructor Summary | |
---|---|
WebLayoutManagerImpl()
|
Method Summary | |
---|---|
Widget |
createWidget(com.sun.facelets.FaceletContext ctx,
String type,
String mode,
String valueName,
List<FieldDefinition> fieldDefinitions,
String label,
String helpLabel,
Boolean translated,
Map<String,Serializable> properties,
Widget[] subWidgets)
Returns a widget computed from given information. |
Widget |
createWidget(com.sun.facelets.FaceletContext ctx,
String type,
String mode,
String valueName,
Map<String,Serializable> properties,
Widget[] subWidgets)
Returns a widget computed from given information. |
com.sun.facelets.FaceletHandler |
getFaceletHandler(com.sun.facelets.FaceletContext ctx,
com.sun.facelets.tag.TagConfig config,
Widget widget)
Returns the facelet handler for given widget. |
Layout |
getLayout(com.sun.facelets.FaceletContext ctx,
LayoutDefinition layoutDef,
String mode,
String valueName,
List<String> selectedRows,
boolean selectAllRowsByDefault)
Returns the computed layout for this definition, mode and list of selected rows in given context, or null if the layout definition is null. |
Layout |
getLayout(com.sun.facelets.FaceletContext ctx,
String layoutName,
String mode,
String valueName)
Returns the computed layout for this name and mode in given context, or null if no layout with this name is found. |
Layout |
getLayout(com.sun.facelets.FaceletContext ctx,
String layoutName,
String mode,
String valueName,
List<String> selectedRows,
boolean selectAllRowsByDefault)
Returns the computed layout for this name, mode and list of selected rows in given context, or null if no layout with this name is found. |
LayoutDefinition |
getLayoutDefinition(String layoutName)
Returns the registered layout definition for this name. |
List<String> |
getLayoutDefinitionNames()
Returns the names of all the registered layout definitions |
WidgetDefinition |
getWidgetDefinition(String widgetName)
Returns the registered widget definition for this name. |
WidgetType |
getWidgetType(String typeName)
Returns the registered widget type for this type name. |
WidgetTypeDefinition |
getWidgetTypeDefinition(String typeName)
Returns the widget type definition with given name, or null if no widget type with this name is found. |
List<WidgetTypeDefinition> |
getWidgetTypeDefinitions()
Returns the widget type definitions for all the registered widget types. |
WidgetTypeHandler |
getWidgetTypeHandler(String typeName)
Returns the widget type handler for the registered widget type with this type name. |
void |
registerContribution(Object contribution,
String extensionPoint,
ComponentInstance contributor)
|
void |
registerLayout(LayoutDefinition layoutDef)
|
void |
registerWidget(WidgetDefinition widgetDef)
|
void |
registerWidgetType(WidgetTypeDefinition desc)
|
void |
unregisterContribution(Object contribution,
String extensionPoint,
ComponentInstance contributor)
|
void |
unregisterLayout(LayoutDefinition layoutDef)
|
void |
unregisterWidget(WidgetDefinition widgetDef)
|
void |
unregisterWidgetType(WidgetTypeDefinition desc)
|
Methods inherited from class org.nuxeo.runtime.model.DefaultComponent |
---|
activate, applicationStarted, deactivate, getAdapter, registerExtension, unregisterExtension |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ComponentName NAME
public static final String WIDGET_TYPES_EP_NAME
public static final String WIDGETS_EP_NAME
public static final String LAYOUTS_EP_NAME
Constructor Detail |
---|
public WebLayoutManagerImpl()
Method Detail |
---|
public void registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
registerContribution
in class DefaultComponent
public void unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
unregisterContribution
in class DefaultComponent
public void registerWidgetType(WidgetTypeDefinition desc)
registerWidgetType
in interface LayoutManager
public void unregisterWidgetType(WidgetTypeDefinition desc)
unregisterWidgetType
in interface LayoutManager
public void registerLayout(LayoutDefinition layoutDef)
registerLayout
in interface LayoutManager
public void unregisterLayout(LayoutDefinition layoutDef)
unregisterLayout
in interface LayoutManager
public void registerWidget(WidgetDefinition widgetDef)
registerWidget
in interface LayoutManager
public void unregisterWidget(WidgetDefinition widgetDef)
unregisterWidget
in interface LayoutManager
public WidgetType getWidgetType(String typeName)
LayoutManager
If the no widget type is found with this name, return null.
getWidgetType
in interface LayoutManager
public WidgetTypeDefinition getWidgetTypeDefinition(String typeName)
LayoutManager
getWidgetTypeDefinition
in interface LayoutManager
public List<WidgetTypeDefinition> getWidgetTypeDefinitions()
LayoutManager
getWidgetTypeDefinitions
in interface LayoutManager
public LayoutDefinition getLayoutDefinition(String layoutName)
LayoutManager
If the no definition is found with this name, return null.
getLayoutDefinition
in interface LayoutManager
public List<String> getLayoutDefinitionNames()
LayoutManager
getLayoutDefinitionNames
in interface LayoutManager
public WidgetDefinition getWidgetDefinition(String widgetName)
LayoutManager
If the no definition is found with this name, return null.
getWidgetDefinition
in interface LayoutManager
public WidgetTypeHandler getWidgetTypeHandler(String typeName) throws WidgetException
WebLayoutManager
If the no widget type is found with this name, return null.
getWidgetTypeHandler
in interface WebLayoutManager
WidgetException
public Layout getLayout(com.sun.facelets.FaceletContext ctx, String layoutName, String mode, String valueName) throws LayoutException
WebLayoutManager
When a widget is configured not to be rendered in this mode, the layout will hold a null value instead. As well, when a row does not hold any non-null widget in this mode, the layout will not hold it.
getLayout
in interface WebLayoutManager
ctx
- the facelet context this layout will be computed in. If
context is null, no expressions can be resolved during
computing.layoutName
- the layout definition name.mode
- the mode.valueName
- the value name to use when computing tag attributes.
LayoutException
WebLayoutManager.getLayout(FaceletContext, String, String, String, List, boolean)
public Layout getLayout(com.sun.facelets.FaceletContext ctx, String layoutName, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault)
WebLayoutManager
getLayout
in interface WebLayoutManager
layoutName
- the layout definition name.
LayoutManager.getLayoutDefinition(String)
,
WebLayoutManager.getLayout(FaceletContext, LayoutDefinition, String, String, List,
boolean)
public Layout getLayout(com.sun.facelets.FaceletContext ctx, LayoutDefinition layoutDef, String mode, String valueName, List<String> selectedRows, boolean selectAllRowsByDefault)
WebLayoutManager
When a widget is configured not to be rendered in this mode, the layout will hold a null value instead. As well, when a row does not hold any non-null widget in this mode, the layout will not hold it.
If parameter selectedRows is not null, layout rows will be filtered according to this value. If selectedRows is null and parameter selectAllRowsByDefault is true, all rows will be taken into account, even rows marked as not selected by default.
getLayout
in interface WebLayoutManager
ctx
- the facelet context this layout will be computed in. If
context is null, no expressions can be resolved during
computing.layoutDef
- the layout definition instance.mode
- the mode.valueName
- the value name to use when computing tag attributes.selectedRows
- the list of selected rows namesselectAllRowsByDefault
- boolean indicating if all rows should be
considered selected by default in case parameter selectedRows
resolves to null.
public com.sun.facelets.FaceletHandler getFaceletHandler(com.sun.facelets.FaceletContext ctx, com.sun.facelets.tag.TagConfig config, Widget widget)
WebLayoutManager
getFaceletHandler
in interface WebLayoutManager
ctx
- the facelet context.config
- the tag config, used to hook the handler in the jsf tree.widget
- the computed widget.
public Widget createWidget(com.sun.facelets.FaceletContext ctx, String type, String mode, String valueName, Map<String,Serializable> properties, Widget[] subWidgets)
WebLayoutManager
createWidget
in interface WebLayoutManager
ctx
- the facelet context this layout will be computed in. If
context is null, no expressions can be resolved during
computing.type
- the widget type name.mode
- the mode.valueName
- the value name to use when computing tag attributes.properties
- optional properties to use when computing the widget.subWidgets
- optional sub widgets for this widget.
WebLayoutManager.createWidget(FaceletContext, String, String, String, List, String,
String, Boolean, Map, Widget[])
public Widget createWidget(com.sun.facelets.FaceletContext ctx, String type, String mode, String valueName, List<FieldDefinition> fieldDefinitions, String label, String helpLabel, Boolean translated, Map<String,Serializable> properties, Widget[] subWidgets)
WebLayoutManager
createWidget
in interface WebLayoutManager
ctx
- the facelet context this layout will be computed in. If
context is null, no expressions can be resolved during
computing.type
- the widget type name.mode
- the mode.valueName
- the value name to use when computing tag attributes.label
- the widget labelhelpLabel
- the widget help labeltranslated
- if true, the labels will be translatedproperties
- optional properties to use when computing the widget.subWidgets
- optional sub widgets for this widget.
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |