| com.sun.jbi.jsf.factory.PropertySheetAdaptor
All known Subclasses: com.sun.jbi.jsf.factory.PropertySheetAdaptorBase,
| PropertySheetAdaptor | | public interface PropertySheetAdaptor (Code) | | This interface defines the methods required by
DynamicPropertySheetFactory . By providing these methods, you are
able to interface some tree structure with the
DynamicPropertySheetFactory so that whole or partial trees can be
created without having to do any tree conversion work (the work is done
by the TreeAdaptor implementation in conjunction with the
DynamicPropretySheetFactory ).
The TreeAdaptor implementation must have a public
static TreeAdaptor getInstance(FacesContext, LayoutComponent,
UIComponent) method in order to get access to an instance of the
TreeAdaptor instance.
author:
Ken Paulsen (ken.paulsen@sun.com) |
| Method Summary | |
| public Map<String, UIComponent> | getFacets(UIComponent comp, Object nodeObject)
This method returns any facets that should be applied to the
PropertySheet (comp). | | public String | getFactoryClass()
| | public Map<String, Object> | getFactoryOptions()
| | public Map<String, List<Handler>> | getHandlersByType(UIComponent comp, Object nodeObject)
Advanced framework feature which provides better handling for
things such as expanding PropertySheets, beforeEncode, and other
events.
This method should return a Map of List
of Handler objects. | | public String | getId()
| | public UIComponent | getPropertySheet(UIComponent parent)
| | public void | init()
This method is called shortly after
getInstance(FacesContext, LayoutComponent, UIComponent). |
| getFacets | | public Map<String, UIComponent> getFacets(UIComponent comp, Object nodeObject)(Code) | | This method returns any facets that should be applied to the
PropertySheet (comp). Useful facets for the sun
PropertySheet component are: "content" and "image".
Facets that already exist on comp, or facets that
are directly added to comp do not need to be returned
from this method.
Parameters:
comp - The tree node UIComponent.
Parameters:
nodeObject - The (model) object representing the tree node. |
| getFactoryClass | | public String getFactoryClass()(Code) | | This method returns the UIComponent factory class
implementation that should be used to create a
PropertySheet for the given tree node model object.
|
| getFactoryOptions | | public Map<String, Object> getFactoryOptions()(Code) | | This method returns the "options" that should be supplied to the
factory that creates the PropertySheet.
Some useful options for the standard PropertySheet
component include:
- propertySheetId
- propertySheetSectionIdTag
- propertyIdTag
- staticTextIdTag
- dropDownIdTag
- dropDownDefaultLevel
- hiddenFieldIdTag
- componentName
- targetName
- instanceName
- propertySheetAdaptorClass
See PropertySheet component documentation for more details.
|
| getHandlersByType | | public Map<String, List<Handler>> getHandlersByType(UIComponent comp, Object nodeObject)(Code) | | Advanced framework feature which provides better handling for
things such as expanding PropertySheets, beforeEncode, and other
events.
This method should return a Map of List
of Handler objects. Each List in the
Map should be registered under a key that cooresponds
to to the "event" in which the Handlers should be
invoked.
|
| getId | | public String getId()(Code) | | This method returns the id for the given tree node
model object.
|
| getPropertySheet | | public UIComponent getPropertySheet(UIComponent parent)(Code) | | Returns the PropertySheets for the given
PropertySheet model Object.
|
| init | | public void init()(Code) | | This method is called shortly after
getInstance(FacesContext, LayoutComponent, UIComponent). It
provides a place for post-creation initialization to take occur.
|
|
|