| com.sun.rave.web.ui.component.util.descriptors.LayoutElement
All known Subclasses: com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase, com.sun.rave.web.ui.component.util.descriptors.LayoutForEach, com.sun.rave.web.ui.component.util.descriptors.LayoutWhile, com.sun.rave.web.ui.component.util.descriptors.LayoutAttribute, com.sun.rave.web.ui.component.util.descriptors.LayoutStaticText, com.sun.rave.web.ui.component.util.descriptors.LayoutIf, com.sun.rave.web.ui.component.util.descriptors.LayoutComponent, com.sun.rave.web.ui.component.util.descriptors.LayoutFacet, com.sun.rave.web.ui.component.util.descriptors.LayoutMarkup,
| LayoutElement | | public interface LayoutElement extends java.io.Serializable(Code) | | This interface is declares the methods required to be a
LayoutElement. A LayoutElement is the building block of the tree
structure which defines a layout for a particular component. There are
different implementations of LayoutElement that provide various
different types of functionality and data. Some examples are:
- Conditional (
LayoutIf ), this allows portions of the
layout tree to be conditionally rendered.
- Iterative (
LayoutWhile ), this allows portions of the
layout tree to be iteratively rendered.
- UIComponent (
LayoutComponent ), this allows concrete
UIComponents to be used. If the component doesn't already exist,
it will be created automatically.
- Facet place holders (
LayoutFacet ), this provides a means
to specify where a facet should be rendered. It is not a facet
itself but where a facet should be drawn. However, in addition,
it may specify a default value if no facet was provided.
author:
Ken Paulsen (ken.paulsen@sun.com) |
| addChildLayoutElement | | public void addChildLayoutElement(LayoutElement element)(Code) | | This method is used to add a LayoutElement. LayoutElements should be
added sequentially in the order in which they are to be rendered.
|
| dispatchHandlers | | public Object dispatchHandlers(FacesContext context, String eventType, EventObject event)(Code) | | This method iterates over the handlers and executes each one. A
HandlerContext will be created to pass to each Handler. The
HandlerContext object is reused across all Handlers that are
invoked; the setHandler(Handler) method is invoked with the
correct Handler descriptor before the handler is executed.
Parameters:
context - The FacesContext
Parameters:
eventType - The event type which is being fired
Parameters:
event - An optional EventObject providing more detail By default, (null) is returned. However, if any of thehandlers produce a non-null return value, then the value fromthe last handler to produces a non-null return value isreturned. |
| encode | | public void encode(FacesContext context, UIComponent component) throws IOException(Code) | | This method performs any encode action for this particular
LayoutElement.
Parameters:
context - The FacesContext
Parameters:
component - The UIComponent |
| getChildLayoutElements | | public List getChildLayoutElements()(Code) | | This method returns the child LayoutElements as a List.
List of LayoutElements |
| getHandlers | | public List getHandlers(String type)(Code) | | This method retrieves the Handlers for the requested type.
Parameters:
type - The type of Handlers to retrieve. A List of Handlers. |
| getId | | public String getId(FacesContext context, UIComponent parent)(Code) | | Accessor method for id. This should always return a non-null value,
it may return "" if id does not apply.
a non-null id |
| getLayoutDefinition | | public LayoutDefinition getLayoutDefinition()(Code) | | This method returns the LayoutDefinition. If unable to, it will throw
an Exception.
The LayoutDefinition |
| getParent | | public LayoutElement getParent()(Code) | | This method returns the parent LayoutElement.
parent LayoutElement |
| setHandlers | | public void setHandlers(String type, List handlers)(Code) | | This method associates 'type' with the given list of Handlers.
Parameters:
type - The String type for the List of Handlers
Parameters:
handlers - The List of Handlers |
|
|