Java Doc for LayoutElementBase.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » web » ui » component » util » descriptors » Java Source Code / Java DocumentationJava Source Code and Java Documentation

This class provides some common functionality between the various types of LayoutElements. It is the base class of most implementations (perhaps all).

This is the "type" for handlers to be invoked during the encoding of this element.

This method is responsible for creating a new HandlerContext.

This method iterates over the handlers and executes each one.

As currently implemented, this method is essentially a utility method.

This is the base implementation for encode.

This method is a convenience method for encoding the given UIComponent.

This method allows each LayoutElement to provide it's own encode functionality.

This method retrieves the Handlers for the requested type.

Accessor method for id.

This method generally should not be used.

This method will attempt to resolve EL strings in the given value.

This method provides a means to set the "handlersByType" Map. Normally this is done for each type individually via LayoutElementBase.setHandlers(String,List) .

This is the "type" for handlers to be invoked after the encoding of this element.

This is the "type" for handlers to be invoked before the encoding of this element.

This is the "type" for handlers to be invoked during the encoding of this element. This occurs before any child LayoutElements are invoked and only if child Elements are to be invoked.

This method is responsible for creating a new HandlerContext. It does not set the Handler descriptor. This is done right before a Handler is invoked. This allows the HandlerContext object to be reused.

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.

As currently implemented, this method is essentially a utility method. May want to rethink this.

This is the base implementation for encode. Typically each type of LayoutElement wants to do something specific then conditionally have its children rendered. This method invokes the abstract method "encodeThis" to do specific functionality, it the walks the children and renders them, if encodeThis returns true. It skips the children if encodeThis returns false.

This method is a convenience method for encoding the given UIComponent. It calls the appropriate encoding methods on the component and calls itself recursively for all UIComponent children that do not render their own children.

This method allows each LayoutElement to provide it's own encode functionality. If the LayoutElement should render its children, this method should return true. Otherwise, this method should return false.

This method retrieves the Handlers for the requested type.

This method retrieves the Handlers for the requested type. But also includes any handlers that are associated with the instance (i.e. the UIComponent).

This method provides access to the "handlersByType" Map.

Accessor method for id. This returns a non-null value, it may return "" if id is not set or does not apply.

This method will also attempt to resolve EL strings.

This method generally should not be used. It does not resolve expressions. Instead use LayoutElementBase.getId(FacesContext,UIComponent) .

This method will attempt to resolve EL strings in the given value.

This method associates 'type' with the given list of Handlers.

This method provides a means to set the "handlersByType" Map. Normally this is done for each type individually via LayoutElementBase.setHandlers(String,List) . This Map may not be null (null will be ignored) and should contain entries that map to Lists of Handler s.