com.sun.rave.web.ui.component.util.descriptors
Class LayoutMarkup

java.lang.Object
  extended by com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase
      extended by com.sun.rave.web.ui.component.util.descriptors.LayoutMarkup
All Implemented Interfaces:
LayoutElement, java.io.Serializable

public class LayoutMarkup
extends LayoutElementBase
implements LayoutElement

This class defines a LayoutMarkup. A LayoutMarkup provides a means to start a markup tag and associate the current UIComponent with it for tool support. It also has the benefit of properly closing the markup tag for you.

See Also:
Serialized Form

Field Summary
static Handler afterEncodeHandler
           
static HandlerDefinition afterEncodeHandlerDef
           
static java.lang.String TYPE_BOTH
           This markup type writes out both the opening and closing tags.
static java.lang.String TYPE_CLOSE
           This markup type writes out the closing tag.
static java.lang.String TYPE_OPEN
           This markup type writes out the opening tag.
 
Fields inherited from class com.sun.rave.web.ui.component.util.descriptors.LayoutElementBase
AFTER_ENCODE, BEFORE_ENCODE, ENCODE
 
Constructor Summary
LayoutMarkup(LayoutElement parent, java.lang.String tag, java.lang.String type)
           Constructor.
 
Method Summary
static void afterEncodeHandler(HandlerContext context)
           This handler takes care of closing the tag.
protected  boolean encodeThis(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
           This method displays the text described by this component.
 java.lang.String getTag()
           
 java.lang.String getType()
           
 
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
 
Methods inherited from interface com.sun.rave.web.ui.component.util.descriptors.LayoutElement
addChildLayoutElement, dispatchHandlers, dispatchHandlers, encode, getChildLayoutElements, getHandlers, getId, getLayoutDefinition, getParent, getUnevaluatedId, setHandlers
 

Field Detail

afterEncodeHandlerDef

public static final HandlerDefinition afterEncodeHandlerDef

afterEncodeHandler

public static final Handler afterEncodeHandler

TYPE_BOTH

public static final java.lang.String TYPE_BOTH

This markup type writes out both the opening and closing tags.

See Also:
Constant Field Values

TYPE_CLOSE

public static final java.lang.String TYPE_CLOSE

This markup type writes out the closing tag.

See Also:
Constant Field Values

TYPE_OPEN

public static final java.lang.String TYPE_OPEN

This markup type writes out the opening tag.

See Also:
Constant Field Values
Constructor Detail

LayoutMarkup

public LayoutMarkup(LayoutElement parent,
                    java.lang.String tag,
                    java.lang.String type)

Constructor.

Method Detail

getTag

public java.lang.String getTag()

getType

public java.lang.String getType()

encodeThis

protected boolean encodeThis(javax.faces.context.FacesContext context,
                             javax.faces.component.UIComponent component)
                      throws java.io.IOException

This method displays the text described by this component. If the text includes an EL expression, it will be evaluated. It returns true to render children.

Specified by:
encodeThis in class LayoutElementBase
Parameters:
context - The FacesContext
component - The UIComponent
Returns:
false
Throws:
java.io.IOException

afterEncodeHandler

public static void afterEncodeHandler(HandlerContext context)
                               throws java.io.IOException

This handler takes care of closing the tag.

Parameters:
context - The HandlerContext.
Throws:
java.io.IOException