|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LayoutElement
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:
LayoutIf
), this allows portions of the
layout tree to be conditionally rendered.LayoutWhile
), this allows portions of the
layout tree to be iteratively rendered.LayoutComponent
), this allows concrete
UIComponents to be used. If the component doesn't already exist,
it will be created automatically.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.
Method Summary | |
---|---|
void |
addChildLayoutElement(LayoutElement element)
This method is used to add a LayoutElement. |
java.lang.Object |
dispatchHandlers(javax.faces.context.FacesContext context,
java.lang.String eventType,
java.util.EventObject event)
This method iterates over the handlers and executes each one. |
java.lang.Object |
dispatchHandlers(HandlerContext handlerCtx,
java.util.List handlers)
|
void |
encode(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
This method performs any encode action for this particular LayoutElement. |
java.util.List |
getChildLayoutElements()
This method returns the child LayoutElements as a List. |
java.util.List |
getHandlers(java.lang.String type)
This method retrieves the Handlers for the requested type. |
java.lang.String |
getId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent parent)
Accessor method for id. |
LayoutDefinition |
getLayoutDefinition()
This method returns the LayoutDefinition. |
LayoutElement |
getParent()
This method returns the parent LayoutElement. |
java.lang.String |
getUnevaluatedId()
This method generally should not be used. |
void |
setHandlers(java.lang.String type,
java.util.List handlers)
This method associates 'type' with the given list of Handlers. |
Method Detail |
---|
void addChildLayoutElement(LayoutElement element)
java.util.List getChildLayoutElements()
LayoutElement getParent()
LayoutDefinition getLayoutDefinition()
java.util.List getHandlers(java.lang.String type)
This method retrieves the Handlers for the requested type.
type
- The type of Handlers to retrieve.
void setHandlers(java.lang.String type, java.util.List handlers)
This method associates 'type' with the given list of Handlers.
type
- The String type for the List of Handlershandlers
- The List of Handlersjava.lang.String getId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent parent)
java.lang.String getUnevaluatedId()
This method generally should not be used. It does not resolve
expressions. Instead use
getId(FacesContext, UIComponent)
.
void encode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) throws java.io.IOException
context
- The FacesContextcomponent
- The UIComponent
java.io.IOException
java.lang.Object dispatchHandlers(HandlerContext handlerCtx, java.util.List handlers)
java.lang.Object dispatchHandlers(javax.faces.context.FacesContext context, java.lang.String eventType, java.util.EventObject event)
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.
context
- The FacesContexteventType
- The event type which is being firedevent
- An optional EventObject providing more detail
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |