| java.lang.Object
 com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase
com.sun.rave.web.ui.component.util.descriptors.LayoutComponent
| Method Summary | |
| public void | addChildLayoutElement(LayoutElement element)
This method overrides LayoutElementBase.addChildLayoutElement().
Child LayoutElements for LayoutComponent are limited to LayoutFacet
objects. | | public void | addOption(String name, Object value)
This method adds an option to the LayoutComponent. | | public void | addOptions(Map map)
This method adds all the options in the given Map to the
LayoutComponent. | | public Object | afterCreate(FacesContext context, UIComponent component)
This method is invoked after the Component described by this
LayoutComponent is created. | | public Object | beforeCreate(FacesContext context, UIComponent parent)
This method is invoked before the Component described by this
LayoutComponent is created. | | public boolean | containsOption(String name)
| | protected boolean | encodeThis(FacesContext context, UIComponent component)
This method allows each LayoutElement to provide it's own encode
functionality. | | public UIComponent | getChild(FacesContext context, UIComponent parent)
This method will find or create a UIComponent as
described by this LayoutComponent descriptor. | | public Object | getEvaluatedOption(FacesContext ctx, String name, UIComponent component)
Accessor method for an option. | | public Object | getOption(String name)
Accessor method for an option. | | public Map | getOptions()
This method returns the options as a Map. | | public ComponentType | getType()
| | public boolean | isFacetChild()
This method returns true if the child should be added to the parent
component as a facet. | | public boolean | isOverwrite()
Determines if this component should be created even if there is
already an existing UIComponent. | | public void | setFacetChild(boolean facetChild)
| | public void | setOptions(Map options)
| | public void | setOverwrite(boolean value)
Determines if this component should be created even if there is
already an existing UIComponent. |
| AFTER_CREATE | | final public static String AFTER_CREATE(Code) | | This is the "type" for handlers to be invoked to handle
"afterCreate" functionality for this element.
|
| BEFORE_CREATE | | final public static String BEFORE_CREATE(Code) | | This is the "type" for handlers to be invoked to handle
"beforeCreate" functionality for this element.
|
| FACET_NAME | | final public static String FACET_NAME(Code) | | This defines the property key for specifying the facet name in
which the component should be stored under in its parent
UIComponent.
|
| addChildLayoutElement | | public void addChildLayoutElement(LayoutElement element)(Code) | | This method overrides LayoutElementBase.addChildLayoutElement().
Child LayoutElements for LayoutComponent are limited to LayoutFacet
objects. This method ensures that only LayoutFacet objects are
added. If any other types are added, an IllegalArgumentException
will be thrown.
Parameters:
element - The LayoutElement to add.
throws:
IllegalArgumentException - Thrown if LayoutElement is not aLayoutFacet |
| addOption | | public void addOption(String name, Object value)(Code) | | This method adds an option to the LayoutComponent. Options may be
useful in constructing the LayoutComponent.
Parameters:
name - The name of the option
Parameters:
value - The value of the option (may be List or String) |
| addOptions | | public void addOptions(Map map)(Code) | | This method adds all the options in the given Map to the
LayoutComponent. Options may be useful in constructing the
LayoutComponent.
Parameters:
map - The map of options to add. |
| afterCreate | | public Object afterCreate(FacesContext context, UIComponent component)(Code) | | This method is invoked after the Component described by this
LayoutComponent is created. This allows handlers registered for
"afterCreate" functionality to be invoked.
Parameters:
context - The FacesContext The result of invoking the handlers (null by default) |
| beforeCreate | | public Object beforeCreate(FacesContext context, UIComponent parent)(Code) | | This method is invoked before the Component described by this
LayoutComponent is created. This allows handlers registered for
"beforeCreate" functionality to be invoked.
Parameters:
context - The FacesContext The result of invoking the handlers (null by default) |
| containsOption | | public boolean containsOption(String name)(Code) | | This method returns true/false based on whether the given option
name has been set.
Parameters:
name - The option name to look for. true/false depending on whether the options exists. |
| encodeThis | | protected boolean encodeThis(FacesContext context, UIComponent component) throws IOException(Code) | | This method allows each LayoutElement to provide it's own encode
functionality. If the LayoutComponent should render its children,
this method should return true. Otherwise, this method should
return false.
Parameters:
context - The FacesContext
Parameters:
component - The UIComponent true if children are to be rendered, false otherwise. |
| getChild | | public UIComponent getChild(FacesContext context, UIComponent parent) throws IOException(Code) | | This method will find or create a UIComponent as
described by this LayoutComponent descriptor. If the
component already exists as a child or facet, it will be returned.
If it creates a new UIComponent, it will typically be
added to the given parent UIComponent as a facet (this
actually depends on the factory that instantiates the
UIComponent).
Parameters:
context - The FacesContext
Parameters:
parent - The UIComponent to serve as the parent tosearch and to store the new UIComponent. The UIComponent requested (found or newly created) |
| getEvaluatedOption | | public Object getEvaluatedOption(FacesContext ctx, String name, UIComponent component)(Code) | | Accessor method for an option. This method evaluates our own
expressions (not JSF expressions).
Parameters:
name - The option name to retrieve
Parameters:
ctx - The FacesContext
Parameters:
component - The UIComponent (may be null) The option value (List or String), or null if not found.
See Also: LayoutComponent.getOption(String) |
| getOptions | | public Map getOptions()(Code) | | This method returns the options as a Map. This method does not
evaluate expressions.
Map of options. |
| isFacetChild | | public boolean isFacetChild()(Code) | | This method returns true if the child should be added to the parent
component as a facet. Otherwise, it returns false indicating that
it should exist as a real child. The default is true.
True if the child UIComponent should be added as a facet. |
| isOverwrite | | public boolean isOverwrite()(Code) | | Determines if this component should be created even if there is
already an existing UIComponent. It will "overwrite"
the existing component if this property is true.
|
| setFacetChild | | public void setFacetChild(boolean facetChild)(Code) | | This method sets whether the child UIComponent should
be set as a facet or a real child.
Parameters:
facetChild - True if the child UIComponent shouldbe added as a facet. |
| setOptions | | public void setOptions(Map options)(Code) | | This method sets the Map of options.
Parameters:
options - Map of options. |
| setOverwrite | | public void setOverwrite(boolean value)(Code) | | Determines if this component should be created even if there is
already an existing UIComponent. It will "overwrite"
the existing component if this property is true.
|
| Methods inherited from com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase | public void addChildLayoutElement(LayoutElement element)(Code)(Java Doc)
protected HandlerContext createHandlerContext(FacesContext context, EventObject event, String eventType)(Code)(Java Doc)
public Object dispatchHandlers(FacesContext context, String eventType, EventObject event)(Code)(Java Doc)
public Object dispatchHandlers(HandlerContext handlerCtx, List handlers)(Code)(Java Doc)
public void encode(FacesContext context, UIComponent component) throws IOException(Code)(Java Doc)
public static void encodeChild(FacesContext context, UIComponent component) throws IOException(Code)(Java Doc)
abstract protected boolean encodeThis(FacesContext context, UIComponent component) throws IOException(Code)(Java Doc)
public List getChildLayoutElements()(Code)(Java Doc)
public List getHandlers(String type)(Code)(Java Doc)
public List getHandlers(String type, UIComponent comp)(Code)(Java Doc)
public Map getHandlersByTypeMap()(Code)(Java Doc)
public String getId(FacesContext context, UIComponent parent)(Code)(Java Doc)
public LayoutDefinition getLayoutDefinition()(Code)(Java Doc)
public LayoutElement getParent()(Code)(Java Doc)
public String getUnevaluatedId()(Code)(Java Doc)
public Object resolveValue(FacesContext context, UIComponent parent, String value)(Code)(Java Doc)
public void setHandlers(String type, List handlers)(Code)(Java Doc)
public void setHandlersByTypeMap(Map map)(Code)(Java Doc)
protected void setParent(LayoutElement parent)(Code)(Java Doc)
|
|
|