|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.rave.web.ui.component.util.descriptors.LayoutElementBase
com.sun.rave.web.ui.component.util.descriptors.LayoutDefinition
public class LayoutDefinition
This represents the top-level LayoutElement
, it is the
container for every other LayoutElement
. By itself, it has no
functionality. Its purpose in life is to group all top-level child
LayoutElement
s. LayoutDefintion objects can be registered
with the LayoutDefinitionManager
.
This class does provide a useful method
getChildLayoutElementById(FacesContext, String, LayoutElement, UIComponent)
which will search recursively for the given child id.
Field Summary | |
---|---|
static java.lang.String |
DECODE
This is the "type" for handlers to be invoked to handle "decode" functionality for this element. |
static java.lang.String |
STATIC_TEXT_FACTORY_CLASS_NAME
This is the full class name of the default StaticTextFactory |
static java.lang.String |
STATIC_TEXT_TYPE
This is a hard-coded LayoutComponent type. |
Fields inherited from class com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase |
---|
AFTER_ENCODE, BEFORE_ENCODE, ENCODE |
Constructor Summary | |
---|---|
LayoutDefinition(java.lang.String id)
Constructor |
Method Summary | |
---|---|
void |
addComponentType(ComponentType type)
This will add the given ComponentType to the map of registered ComponentTypes. |
void |
addResource(Resource res)
This method adds a Resource. |
void |
decode(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
This decode method invokes any registered DECODE handlers. |
protected boolean |
encodeThis(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent component)
The LayoutDefinition does not encode anything for itself, this method simply returns true. |
java.lang.Object |
getAttribute(java.lang.String key)
Retrieve an attribute by key |
static LayoutElement |
getChildLayoutElementById(javax.faces.context.FacesContext context,
java.lang.String id,
LayoutElement parent,
javax.faces.component.UIComponent parentComponent)
This method searches for the requested LayoutComponent by id. |
ComponentType |
getComponentType(java.lang.String typeID)
Retrieve a ComponentType by typeID |
java.util.List |
getResources()
This method returns a List of Resource objects. |
void |
setAttribute(java.lang.String key,
java.lang.Object value)
Associate the given key with the given Object as an attribute. |
Methods inherited from class com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase |
---|
addChildLayoutElement, createHandlerContext, dispatchHandlers, dispatchHandlers, encode, encodeChild, getChildLayoutElements, getHandlers, getHandlers, getHandlersByTypeMap, getId, getLayoutDefinition, getParent, getUnevaluatedId, resolveValue, setHandlers, setHandlersByTypeMap, setParent |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STATIC_TEXT_TYPE
public static final java.lang.String STATIC_TEXT_FACTORY_CLASS_NAME
public static final java.lang.String DECODE
This is the "type" for handlers to be invoked to handle "decode" functionality for this element.
Constructor Detail |
---|
public LayoutDefinition(java.lang.String id)
Method Detail |
---|
public ComponentType getComponentType(java.lang.String typeID)
typeID
- The key used to retrieve the ComponentType
public void addComponentType(ComponentType type)
type
- The ComponentType.public void addResource(Resource res)
res
- The Resource to associate with the LayoutDefinitionpublic java.util.List getResources()
public static LayoutElement getChildLayoutElementById(javax.faces.context.FacesContext context, java.lang.String id, LayoutElement parent, javax.faces.component.UIComponent parentComponent)
context
- FacesContext
id
- id to look forparent
- Search starts from this
LayoutElement
parentComponent
- Parent UIComponent
public java.lang.Object getAttribute(java.lang.String key)
key
- The key used to retrieve the attribute
public void setAttribute(java.lang.String key, java.lang.Object value)
key
- The key associated with the given object (if this key
is already in use, it will replace the previously set attribute
object).value
- The Object to store.protected boolean encodeThis(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
The LayoutDefinition does not encode anything for itself, this method simply returns true.
encodeThis
in class LayoutElementBase
context
- The FacesContextcomponent
- The UIComponent
public void decode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
This decode method invokes any registered DECODE handlers.
context
- The FacesContextcomponent
- The Template
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |