description
property
that is populated from the clay configuration file
when design time tool support is enabled.Clay
's
xml configuration files if the
org.apache.shale.clay.AUTO_RELOAD_CONFIG_FILES
init
parameter is set to true
in the web.xml.ActionListener
.ActionSource
interface.ValueHolder
interface.EditableValueHolder
interface.EditableValueHolder
interface.ActionListenerBean
to the actionListeners
set.AttributeBean
to the attributes
Map collection where
the name
property is the key identifier in the value pair relationship.target
ElementBean
.AttributeBean
's
on the target
ComponentBean
.ElementBean
to the children
set and
fixes up the composition parent relationship.displayElement
map collection using
the jsfid
as the key.children
collection.ConverterBean
and assigns the composition parent.target
's
child ElementBean
.SymbolBean
to the symbols collection.target
ElementBean
.ValidatorBean
and assigns the composition parent.AttributeBean
's
on the target
ComponentBean
.ValueChangeListenerBean
to the set where each instance is
uniquely identified by jsfid
.ComponentBean
invoking CreateActionListenerCommand
.ElementBean
collection of a
ComponentBean
, and invokes the CreateComponentCommand
for
each.ComponentBean
has a ConverterBean
assigned.jsfid
attribute for an HTML
element to a component definition in the XML configuration files.jsfid
attribute for an HTML
element to a component definition in the XML configuration files.ComponentBean
using the extends
attribute.ComponentBean
.UIComponent
properties using the attributes collection of
AttributeBean
by invoking the
Globals.SET_ATTRIBUTE_COMMAND_NAME
Chain
.ValueChangeListenerBean
in the valueChangeListeners
collection, the
CreateValueChangeListenerCommand
command will be invoked.CLAY_CONFIG_FILES
will be watched for changes.Parser.Rule
s that validate a begin CDATA Token
.Parser.Rule
s that validate a begin comment Token
.Parser.Rule
s that validate a begining Token
.ComponentBean
, for a parsed html
document fragment.BuilderFactory
to define the rules that map an HTML element to a Builder
.BuilderFactory
to assemble the rule finder chain.BuilderFactory
to invoke the Globals.FIND_BUILDER_COMMAND_NAME
chain passing this context.ComponentBean
, the method looks for several
types of circular inheritances.TemplateConfigBean
.jspid
.Clay
component to
load the ADD_COMPONENT_COMMAND_NAME from the CLAY_CATALOG_NAME.TemplateComponentConfigBean
.Clay
component.ConfigBean
instance to load
a configuration file.shapeValidator
attribute of the
Clay
component.shapeValidator
attribute of the
Clay
component.shapeValidator
attribute of the
Clay
component.Clay
component.ComponentBean
's that represents a JSF component tree.ViewHandler
will handle full HTML template views using the
Clay
component as the single subtree under the view root.original
view handler.watchDogName
equals
the ComponentBean
that defines the selected
template, remove it.ElementBean
object from a Node
.Comparable
implementation makes the
jsfid
attribute the unique identifier for the object in a
set.ComponentBean
making the
renderId
the ordering identifier instead of the
jsfid
.Comparable
interface makes
the name
property the compared key.Clay
component to build
a component subtree.ClayConfigureListener
by the ClayXmlParser
.displayElements
collection.ConfigBean.ConfigDefinition
's.URL
.ConfigBeanFactory
.ConfigBean
.Digester
instance.ServletContext
.ComponentConfigBean
.Converter
.Command
will create a ActonListener
and assign it to the
parent
.Command
is used to build parent and
child UIComponent
's from the
displayElement
in the ClayContext
.Command
will create a Converter
from the
displayElement
attribute of the
ClayContext
assigning
it to the parent
.ElementBean
from a Node
.renderId
attribute in the Node
.ElementBean
from a Node
.Validator
interface and assigns it
to the parent
from the ClayContext
.decodeMap
.ComponentConfigBean
to identify the
ComponentConfigBean.WatchDog
for the XML configuration files.jsfid
that describes the Stack of ComponentBean
.ClayConfigureListener
on
application shutdown to clean up cached resources.Node
is a starting tag and not a comment,
use the AttributeTokenizer
to realize the node attributes.Node
is a starting, ending, or body text
tag.Parser.Rule
s that validate document type Token
.ElementBean
's
from the html markup resembling the <attributes> node in the clay
DTD, http://shale.apache.org/dtds/clay-config_1_0.dtd.Node
to a
ComponentBean
.encodeMap
.ComponentBean
by
calling the
getRootElement()
method or while invoking the shapeValidator
callback event.ElementBean
from a Node
.ElementBean
.ElementBean
.target
config bean with the
html node
's values.target
config bean with the
html node
's values.ElementBean
and then sets the value attribute to the raw text of
the html node.recursiveRenderChildren
.Node
's.true
.ElementBean
.Parser.Rule
s that validate an end CDATA Token
.Parser.Rule
s that validate an end comment Token
.Command
interfaces.Command
iterates over the ComponentBean
children
collection and invokes the
Globals.ADD_COMPONENT_COMMAND_NAME
for each
ElementBean
.ComponentBean
has a ConverterBean
assigned.CreateValidatorCommand
using the
Globals.ADD_VALIDATOR_COMMAND_NAME
command to create a
Validator
.Globals.ADD_VALUE_CHANGE_LISTENER_COMMAND_NAME
command to create a ValueChangeListener
.componentType
is "javax.faces.ViewRoot",
assign the property overrides is present.ClayContext
to build a ActionListener
and
assign it to the context parent
using the context
displayElement
that is derived from type
ComponentBean
.Converter
interface
assigning to the parent
.ValueChangeListener
and assigns it to the
parent
attribute.AttributeBean
on the ClayContext
to see
if the value is a binding EL.value()
method.BuilderRuleContext
to find the current html Node
.Node
's to
corresponding builders.BuilderRuleContext
to find the current html
Node
.jsfid
attribute, and its value is
"ignore", child elements will be rendered as comment/verbatim
content.BuilderRuleContext
to find the current html Node
.Node
is a input element, return the correct builder.JsfDefaultBuilder
without condition.Node
is a label, return return the
OutputLabelBuilder
and complete the chain by returning a
true
value.true
value if the current html Node
is
an option.true
if a match was made from a select
Node
to a SelectOneMenuBuilder
or a SelectManyMenuBuilder
.true
value, ending the chain execution if the
html Node
has a jsfid
html attribute and is a span
HTML element.false
if the html Node
was not a textarea.Builder
for the default namespace.Builder
for a unknown namespace.ConfigBean
that can be used
to return component metadata.ElementBean
from a
HTML Node
.FormBuilder
regardless if the html form attribute has a
jsfid
.Clay
component.Collection
of ActionListenerBean
.viewId
is suffixed with the Clay template suffix,
rewrite the returned actionUrl with a clay suffix.Clay
template features.value
into a string array using
the element delimiter
and element separator
.AssignPropertiesCommand
.AttributeBean
by the classes name
property.Iterator
handeling
AttributeBean
objects in the attributes
collection.Map
collection of AttributeBean
objects.Builder
that
is assigned the task of converting the html node to a corresponding component
metadata used to construct a JSF resource.Builder
that
is assigned the task of converting the html node to a corresponding component
metadata used to construct a JSF resource.Builder
.Builder
that
is assigned the task of converting the html node to a corresponding component
metadata used to construct a JSF resource.true
if the builder handles converting the node's
children or false
if it's handled by the parent.nodes
's children.true
by default meaning that the
parent will render children.true
by default meaning that the
parent will render children.Catalog
with a name of
Globals.CLAY_CATALOG_NAME
in the
Globals.CLAY_RESOURCE_NAME
configuration file.Globals.CLAY_RESOURCE_NAME
.Globals.BUILDER_CATALOG_NAME
from file
Globals.BUILDER_RESOURCE_NAME
.templateURL
.ElementBean
.List
of child nodes.Iterator
to the children
set.ActionListeners
and
ValueChangeListeners
.javax.faces.HtmlCommandButton
component.componentType
from the target HTML
Node
.javax.faces.HtmlForm
to
populate the ElementBean
.javax.faces.HtmlInputTextarea
used to define the
ElementBean
from the HTML Node
.javax.faces.HtmlInputTextarea
used to define the
ElementBean
from the HTML Node
.org.apache.shale.clay.component.Clay
that will populate the
componentType property of the ElementBean
being created.jsfid
as an HTML attribute.javax.faces.HtmlOutputLabel
that will populate the
ElementBean
being created.javax.faces.HtmlOutputLink
.javax.faces.HtmlSelectBooleanCheckbox
that will create a
checkbox component.javax.faces.SelectItem
that will populate a ElementBean
and create an html option.javax.faces.SelectItems
that will be set to the target ElementBean
and used to create
options for a collection.javax.faces.HtmlSelectManyMenu
that will populate the
target ElementBean
.javax.faces.HtmlSelectOneMenu
that will populate the
target ElementBean
.javax.faces.HtmlSelectOneRadio
.javax.faces.HtmlOutputText
.javax.faces.HtmlOutputText
.Clay
component.ConfigBean
that pools a
collection of faces meta-component definitions.ConfigBean.ConfigDefinition
defining the files.Converter
.Catalog
with a name identified by the
constant Globals.CLAY_CUSTOMIZATION_CATALOG_NAME
.description
of the bean.ComponentBean
used to build the clay subtree
component.jsfid
or null
if not found.ComponentBean
using an identifier.ComponentBean
that is materialized
using a HTML template fragment.jsfid
of the meta component that this
instance inherits from.ComponentBean
's id
.UIComponent.id
property and is used to name the component within the tree.ComponentBean
's id
.ComponentBean
's id
.ComponentBean
's id
.allowBody
property.jsfid
for the component.jsfid
assigned to the ElementBean
.jsfid
from the target HTML
Node
.jsfid
for the
ElementBean
.jsfid
for the target ElementBean
.jsfid
used to populate the ElementBean
.jsfid
used to populate the ElementBean
.jsfid
associated with the ElementBean
being build.jsfid
the
ElementBean
will take.jsfid
associated with the ElementBean
being build.jsfid
that will populate the target
ElementBean
.jsfid
for the ElementBean
.jsfid
that will be set on the
target ElementBean
.jsfid
used to populate the target
ElementBean
.jsfid
for the target
ElementBean
.jsfid
that will populate the target
ElementBean
.jsfid
that will populate the target
ElementBean
.jsfid
for the target ElementBean
.jsfid
for the target ElementBean
.prefix
.Node
.name
searching thru all the children.null
if the node
is a top-level/root node.beginOffset
and
endOffset
.Builder
mapped to a Node
by executing chain
command Globals.FIND_BUILDER_COMMAND_NAME
The
BuilderRuleContext
is passed to the chain.ComponentBean
children
set.renderId
.true
indicating that this
component renders it's children.Clay
component subtree.ServletContext
set
by the init(ServletContext)
method.validator
signature event that is invoked when
the component metadata is retrieved.Iterator
to the validator
set.Collection
of meta validators used to create jsf Validator
object instances.Iterator
to the valueChangeListeners
set.ConfigBean
objects with the ConfigBeanFactory
.ConfigBeanFactory
for determining the ConfigBean that will return a ComponentBean
for a jsfid
.ConfigBean
instances
with the ConfigBeanFactory
.ConfigBean
instances
with the ConfigBeanFactory
.Globals
contains static constants used throughout the clay
plug-in.Builder
is designed to ignore processing on a
block of HTML.ArrayList
that should be
populated into Token
offsets.Clay
HTML or XML full view.request.uri
to determine if it's suffix matches one of
the suffixes
.FORM_MAKKERS
array.ServletContext
as a parameter.ServletContext
.ComponentBean
.Command
has an implied mapping to several html
element types.true
if the node is
a CDATA; otherwise; the default is false
.true
if the faces component that it
builds allows children but the default is false
.true
indicating that the from JSF
component can have children.true
indicating that the from JSF
component can have children.true
indicating that the JSF component mapped to
this html span tag can have children.true
meaning that the target JSF component can
have children.true
indicating that the multi-select component
can have children.true
value indicating that the target JSF
component can have children.true
meaning that the target JSF component can
have children.true
if the node is
a comment; otherwise; the default is false
.true
if the current mode
is design time.true
value if this node is a ending marker.componentType
against the NAMING_CONTAINER_TYPES
list to determine if it is a naming container.Node
instances by name
.true
if
the value is only whitespace.SELF_TERMINATING
table of values.true
if the node is a beginning marker.init
method from the org.apache.shale.clay.AUTO_RELOAD_CONFIG_FILES
init
parameter in the web.xml.true
if the node has a beginning and ending
marker.Iterator
that
will enumerate attributes in the document where the attributes
are represented by a AttributeTokenizer.AttributeEntry
instance.Iterator
interface to enumerate the nodes within the document.JsfDefaultBuilder
that can
transform markup that looks like JSP tags to a graph of
InnerComponentBean
beans.Clay
component.Command
rule has an implied mapping of a html label
Node
to a OutputLabelBuilder
regardless of the mapped
jsfid
- LabelBuilderRule() - Constructor for class org.apache.shale.clay.parser.builder.chain.LabelBuilderRule
-
- LoadBundle - Class in org.apache.shale.clay.component
-
Component counterpart of the standard loadBundle tag.
- LoadBundle() - Constructor for class org.apache.shale.clay.component.LoadBundle
-
- loadConfigFile(URL, String) - Method in interface org.apache.shale.clay.config.ClayConfigParser
-
- loadConfigFile(URL, String) - Method in class org.apache.shale.clay.config.ClayTemplateParser
-
- loadConfigFile(URL, String) - Method in class org.apache.shale.clay.config.ClayXmlParser
-
Loads a configuration file from a
url
.
- loadConfigFiles() - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Loads the
Clay
configration files
into the displayElements
Map.
- loadConfigFiles() - Method in class org.apache.shale.clay.config.beans.TemplateComponentConfigBean
-
This is an overridden method called from the init method.
- loadConfigFiles() - Method in class org.apache.shale.clay.config.beans.TemplateConfigBean
-
This is an overridden method called from the init method.
- loadTemplate(URL) - Method in class org.apache.shale.clay.config.ClayTemplateParser
-
Loads the template file respecting the encoding type.
- loadTemplate(PageData) - Method in class org.apache.shale.clay.taglib.ClayTagValidator
-
Loads the
page
content into a StringBuffer
.
M
- MANAGED_BEAN_MNEMONIC - Static variable in class org.apache.shale.clay.config.Globals
-
EL properties will replaced the literal value of this constant with the
mapped ViewController bean before the expression is evaluated.
- matches(String, Pattern[], boolean) - Method in class org.apache.shale.clay.config.beans.ConfigDefinitionsWatchdogFilter
-
Match the specified expression against the specified precompiled
patterns.
- messages - Static variable in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Message resources for this class.
- messages - Static variable in class org.apache.shale.clay.parser.builder.Builder
-
Message resources for this class.
- MorphBuilder - Class in org.apache.shale.clay.parser.builder
-
This Builder is mapped to the HTML span tag and will morph into any clay
component defined by the
jsfid
attribute in the HTML element.
- MorphBuilder() - Constructor for class org.apache.shale.clay.parser.builder.MorphBuilder
-
- MYFACES_1_1 - Static variable in class org.apache.shale.clay.utils.JSFRuntimeTracker
-
This enumeration indicates the MyFaces 1.1.x runtime is installed.
N
- NAMING_CONTAINER_TYPES - Static variable in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
A static string array of faces component types that are naming
containers.
- nextToken(int, String, String, boolean) - Method in class org.apache.shale.clay.parser.AttributeTokenizer
-
- Node - Class in org.apache.shale.clay.parser
-
This class represents a node within a parsed document.
- Node(Token) - Constructor for class org.apache.shale.clay.parser.Node
-
Overloaded constructor that requires a
Token
object
in the formal parameter.
- NodeTokenizer - Class in org.apache.shale.clay.parser
-
Splits a document into tokens using the following delimiters "<>".
- NodeTokenizer(StringBuffer) - Constructor for class org.apache.shale.clay.parser.NodeTokenizer
-
Constructor with the complete document to parse.
O
- optimizeTree(ComponentBean) - Method in class org.apache.shale.clay.config.beans.TemplateConfigBean
-
Recursively walks down the graph of meta-data
ComponentBean
's
looking at the children of the root
.
- OptionBuilderRule - Class in org.apache.shale.clay.parser.builder.chain
-
This
Command
will return either a SelectItemBuilder
or
a SelectItemsBuilder
if the html Node
is an option and the
option has children.
- OptionBuilderRule() - Constructor for class org.apache.shale.clay.parser.builder.chain.OptionBuilderRule
-
- org.apache.shale.clay.component - package org.apache.shale.clay.component
-
- org.apache.shale.clay.component.chain - package org.apache.shale.clay.component.chain
-
- org.apache.shale.clay.config - package org.apache.shale.clay.config
-
- org.apache.shale.clay.config.beans - package org.apache.shale.clay.config.beans
-
- org.apache.shale.clay.convert - package org.apache.shale.clay.convert
-
- org.apache.shale.clay.faces - package org.apache.shale.clay.faces
-
- org.apache.shale.clay.parser - package org.apache.shale.clay.parser
-
- org.apache.shale.clay.parser.builder - package org.apache.shale.clay.parser.builder
-
- org.apache.shale.clay.parser.builder.chain - package org.apache.shale.clay.parser.builder.chain
-
- org.apache.shale.clay.taglib - package org.apache.shale.clay.taglib
-
- org.apache.shale.clay.utils - package org.apache.shale.clay.utils
-
- OutputLabelBuilder - Class in org.apache.shale.clay.parser.builder
-
- OutputLabelBuilder() - Constructor for class org.apache.shale.clay.parser.builder.OutputLabelBuilder
-
- OutputLinkBuilder - Class in org.apache.shale.clay.parser.builder
-
- OutputLinkBuilder() - Constructor for class org.apache.shale.clay.parser.builder.OutputLinkBuilder
-
P
- PageNotFoundException - Exception in org.apache.shale.clay.config.beans
-
This is an unchecked exception used to identify that
a
Clay
template
could not be found.
- PageNotFoundException(String, String) - Constructor for exception org.apache.shale.clay.config.beans.PageNotFoundException
-
Overloaded constructor requires an error message
and the missing resource.
- parse(ArrayList) - Method in class org.apache.shale.clay.parser.AttributeTokenizer
-
Builds an
ArrayList
of
AttributeTokenizer.AttributeEntry
instances identifying
name and value pairs.
- parse(StringBuffer) - Method in class org.apache.shale.clay.parser.Parser
-
Parse a document fragment into graphs of
Node
.
- parser - Variable in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Uses the digester to load the configuration files
into a object graph cached in
displayElements
.
- Parser - Class in org.apache.shale.clay.parser
-
Parses the document into a tree of nodes using the
NodeTokenizer
.
- Parser() - Constructor for class org.apache.shale.clay.parser.Parser
-
- PluggableLookupCommand - Class in org.apache.shale.clay.utils
-
This chains class performs a check to verify the catalog exists.
- PluggableLookupCommand() - Constructor for class org.apache.shale.clay.utils.PluggableLookupCommand
-
- PropertyActionCommand - Class in org.apache.shale.clay.component.chain
-
This
Command
will create an action
method
binding and assign it to the UIComponent
implementing the
ActionSource
interface.
- PropertyActionCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyActionCommand
-
- PropertyActionListenerCommand - Class in org.apache.shale.clay.component.chain
-
This
Command
will create an actionListener
method binding and assign it to the UIComponent
implementing
the ActionSource
interface.
- PropertyActionListenerCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyActionListenerCommand
-
- PropertyConverterCommand - Class in org.apache.shale.clay.component.chain
-
This
Command
will create an converter
value
binding and assign it to the UIComponent
implementing the
ValueHolder
interface.
- PropertyConverterCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyConverterCommand
-
- PropertyValidatorCommand - Class in org.apache.shale.clay.component.chain
-
This
Command
will create an validator
method
binding and assign it to the UIComponent
implementing the
EditableValueHolder
interface.
- PropertyValidatorCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyValidatorCommand
-
- PropertyValueChangeListenerCommand - Class in org.apache.shale.clay.component.chain
-
This
Command
will create an ValueChangeListener
method binding and assign it to the UIComponent
implementing
the EditableValueHolder
interface.
- PropertyValueChangeListenerCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyValueChangeListenerCommand
-
- PropertyValueCommand - Class in org.apache.shale.clay.component.chain
-
This is the catch all
Command
to handle all attributes that
are not an "action", "actionListener", "validator" and "valueChangeListener".
- PropertyValueCommand() - Constructor for class org.apache.shale.clay.component.chain.PropertyValueCommand
-
- put(Object, Object) - Method in class org.apache.shale.clay.config.beans.Attributes
-
Make the key case insensitive.
R
- realizeComponent(Node, ComponentBean) - Method in class org.apache.shale.clay.parser.builder.ElementBuilder
-
Realizes the inheritance of the
target
ComponentBean
and
and then applies attributes that are optionally nested
under the node
.
- realizeSymbols(ClayContext) - Static method in class org.apache.shale.clay.component.chain.AbstractCommand
-
Evaluates nested symbols.
- realizingInheritance(AttributeBean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
This overload handles fixing up
AttributeBean
inheritance.
- realizingInheritance(ComponentBean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
This method is passed a
ComponentBean
and is
recursively called for each contained component.
- realizingInheritance(ComponentBean) - Method in interface org.apache.shale.clay.config.beans.ConfigBean
-
Fixes up the meta inheritance of a
ComponentBean
.
- recursiveRender(UIComponent, FacesContext) - Method in class org.apache.shale.clay.faces.ClayViewHandler
-
Recursively invokes the rendering of the sub component tree.
- recursiveRenderChildren(UIComponent, FacesContext) - Method in class org.apache.shale.clay.component.Clay
-
Recursively invokes the rendering of the sub component tree.
- refresh(boolean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
This method should be called from key points in the application to invoke
automatic reloading of the configuration files if they have been modified since
last reloaded.
- refresh(boolean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean.WatchDog
-
This method is the watch dog timmer.
- refresh(boolean) - Method in interface org.apache.shale.clay.config.beans.ConfigBean
-
This method should be called from key points in the application to invoke
automatic reloading of the configuration files if they have been modified since
last reloaded.
- refresh() - Static method in class org.apache.shale.clay.config.beans.ConfigBeanFactory
-
This method should be called from key points in the application to invoke
automatic reloading of the configuration files if they have been modified since
last reloaded.
- refresh(boolean) - Method in class org.apache.shale.clay.config.beans.TemplateComponentConfigBean
-
If the
forceReload
is true
,
the displayElements
cache is invalidated.
- refresh(boolean) - Method in class org.apache.shale.clay.config.beans.TemplateConfigBean
-
If the
forceReload
is true
,
the displayElements
cache is invalidated.
- register(ConfigBean) - Static method in class org.apache.shale.clay.config.beans.ConfigBeanFactory
-
This method is invoked to register a class instance implementing
ConfigBean
interface.
- renderView(FacesContext, UIViewRoot) - Method in class org.apache.shale.clay.faces.ClayViewHandler
-
The
viewId
is check to see if it ends with the
same suffix as the full HTML or XML views.
- replace(StringBuffer, Map) - Method in class org.apache.shale.clay.utils.ClayAmalgam
-
Replaces tokens in the
document
with matching tokens in
the context
.
- replaceMnemonic(ClayContext) - Static method in class org.apache.shale.clay.component.chain.AbstractCommand
-
This call is used to substitue an attribute binding expression containing
the
symbols
with the target property value in the ClayContext
.
- replaceMnemonic(ClayContext, String) - Static method in class org.apache.shale.clay.component.chain.AbstractCommand
-
This call is used to substitue an attribute binding expression containing
the
symbols
within the sybmolToken
.
- resolveInheritance() - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
This method is called on startup to resolve the meta inheritance relationships for
each top-level components in the
displayElements
collection.
- restoreState(FacesContext, Object) - Method in class org.apache.shale.clay.component.Clay
-
Restores a component's state.
- restoreView(FacesContext, String) - Method in class org.apache.shale.clay.faces.ClayViewHandler
-
The default view handler implementation will try to
make the viewId end with ".jsp".
- RI_1_1 - Static variable in class org.apache.shale.clay.utils.JSFRuntimeTracker
-
This enumeration indicates the JSF RI 1.1.x runtime is installed.
- RI_1_2 - Static variable in class org.apache.shale.clay.utils.JSFRuntimeTracker
-
This enumeration indicates the JSF RI 1.2.x runtime is installed.
- RUNTIME_ELEMENT_ID - Static variable in class org.apache.shale.clay.config.Globals
-
The literal string used to identify that a clay subtree should be
built at runtime.
S
- saveState(FacesContext) - Method in class org.apache.shale.clay.component.Clay
-
Saves a component's state.
- SelectBooleanCheckboxBuilder - Class in org.apache.shale.clay.parser.builder
-
This
Builder
will create a ElementBean
representing a
javax.faces.HtmlSelectBooleanCheckbox
JSF component.
- SelectBooleanCheckboxBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectBooleanCheckboxBuilder
-
- SelectBuilderRule - Class in org.apache.shale.clay.parser.builder.chain
-
- SelectBuilderRule() - Constructor for class org.apache.shale.clay.parser.builder.chain.SelectBuilderRule
-
- SelectItemBuilder - Class in org.apache.shale.clay.parser.builder
-
This
Builder
will create a ElementBean
that will be used to
create a single html option element.
- SelectItemBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectItemBuilder
-
- SelectItemsBuilder - Class in org.apache.shale.clay.parser.builder
-
- SelectItemsBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectItemsBuilder
-
- SelectManyMenuBuilder - Class in org.apache.shale.clay.parser.builder
-
- SelectManyMenuBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectManyMenuBuilder
-
- SelectOneMenuBuilder - Class in org.apache.shale.clay.parser.builder
-
- SelectOneMenuBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectOneMenuBuilder
-
- SelectOneRadioBuilder - Class in org.apache.shale.clay.parser.builder
-
- SelectOneRadioBuilder() - Constructor for class org.apache.shale.clay.parser.builder.SelectOneRadioBuilder
-
- SET_ATTRIBUTE_COMMAND_NAME - Static variable in class org.apache.shale.clay.config.Globals
-
Chain subchain command invoked by the
AssignPropertiesCommand
to assign the attributes to the components.
- setActionListeners(Collection) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Merges two collections where items in the source collection will override
those in the target collection of
ActionListenerBean
by the jsfid
property.
- setAllowBody(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
This property only applies when using the
Clay
template features.
- setAttribute(AttributeBean) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the current attribute for each in
AssignPropertiesCommand
.
- setAttributes(Map) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Merges a set of
AttributeBean
where items in the source
collection override items in the target collection by the object's
jsfid
property.
- setAttributes(Map) - Method in class org.apache.shale.clay.parser.Node
-
Sets a Map collection of Node attributes.
- setBasename(String) - Method in class org.apache.shale.clay.component.LoadBundle
-
Sets the base name of the resource bundle to be loaded.
- setBindingType(String) - Method in class org.apache.shale.clay.config.beans.AttributeBean
-
Sets a String that indicates the binding type for the attribute.
- setBuilder(Builder) - Method in class org.apache.shale.clay.parser.builder.chain.BuilderRuleContext
-
Sets the target
Builder
.
- setCdata(boolean) - Method in class org.apache.shale.clay.parser.Node
-
Sets a boolean value that identifies this node as
being a CDATA.
- setChild(Object) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets a child component that can be a UIComponent, Validator,
Listener or Converter.
- setChildIndex(int) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the index at which a new component must be added in the list
of childs.
- setChildren(Collection) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Merges two sets of children
ElementBean
.
- setClayJsfid(String) - Method in class org.apache.shale.clay.component.Clay
-
Sets the unique identifier used to build the component subtree.
- setComment(boolean) - Method in class org.apache.shale.clay.parser.Node
-
Sets a boolean value that identifies this node as
being a comment.
- setComponentType(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the component type uses by abstract factories to instantiate
associated JSF resources.
- setConfig(ConfigBean) - Method in interface org.apache.shale.clay.config.ClayConfigParser
-
Sets an instance of the
ConfigBean
that pools a
collection of faces meta-component definitions.
- setConfig(ConfigBean) - Method in class org.apache.shale.clay.config.ClayTemplateParser
-
Sets an object pool for HTML template configuration files.
- setConfig(ConfigBean) - Method in class org.apache.shale.clay.config.ClayXmlParser
-
- setDelimiter(Character) - Method in class org.apache.shale.clay.convert.StringArrayConverter
-
- setDescription(String) - Method in class org.apache.shale.clay.config.beans.AbstractBean
-
Sets the
description
of the bean.
- setDesigntime(boolean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Sets the design time to somthing other than
the default
false
value.
- setDisplayElement(ComponentBean) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the current component metadata used to build
a JSF resource.
- setDisplayElementRoot(ComponentBean) - Method in class org.apache.shale.clay.component.Clay
-
Sets the root
ComponentBean
used to build the clay subtree
component.
- setEnd(boolean) - Method in class org.apache.shale.clay.parser.Node
-
Sets the flag indicating that this node is a ending marker.
- setExtends(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the
jsfid
of the meta component that this meta
component inherits from.
- setFacesContext(FacesContext) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the current faces Context.
- setFacetName(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the facet name that will be used as the identifier when adding the
component to the parent facets collection.
- setHasAParent(ComponentBean) - Method in class org.apache.shale.clay.config.beans.AttributeBean
-
Sets the parent component that contains this object instance.
- setHasAParent(ComponentBean) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the parent that owns this component.
- setId(String) - Method in class org.apache.shale.clay.config.beans.ActionListenerBean
-
Sets the
ComponentBean
's id
.
- setId(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the identifier that is used to populate the JSF
UIComponent.id
property.
- setId(String) - Method in class org.apache.shale.clay.config.beans.ConverterBean
-
Sets the
ComponentBean
's id
.
- setId(String) - Method in class org.apache.shale.clay.config.beans.ValidatorBean
-
Sets the
ComponentBean
's id
.
- setId(String) - Method in class org.apache.shale.clay.config.beans.ValueChangeListenerBean
-
Sets the
ComponentBean
's id
.
- setIncludes(String) - Method in class org.apache.shale.clay.config.beans.ConfigDefinitionsWatchdogFilter
-
Set the comma-delimited regular expression patterns to include
remote host names that match, if any; or
null
for no
restrictions.
- setInheritanceFinal(boolean) - Method in class org.apache.shale.clay.config.beans.AttributeBean
-
Sets a boolean that indicates the meta inheritance relationships have
been resolved.
- setInheritanceFinal(boolean) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets a boolean flag indicating that the meta inheritances
have been resolved.
- setIsAParent(AttributeBean) - Method in class org.apache.shale.clay.config.beans.AttributeBean
-
Sets a parent component that this component extends in terms of
a meta relationship.
- setIsAParent(ComponentBean) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the component that this instance extends.
- setJsfid(String) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the unique identifier for a component metadata definition.
- setJsfid(String) - Method in class org.apache.shale.clay.component.Clay
-
Sets the unique identifier used to build the component subtree.
- setJsfid(String) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Sets the unique meta component identifier.
- setJsfid(String) - Method in class org.apache.shale.clay.taglib.ClayTag
-
Sets the identifier defining component metadata.
- setLastModified(long) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean.XmlConfigDef
-
Sets the last time the target configuration file was modified.
- setLastModified(long) - Method in interface org.apache.shale.clay.config.beans.ConfigBean.ConfigDefinition
-
Sets the last modified date of the config file.
- setManagedBeanName(String) - Method in class org.apache.shale.clay.component.Clay
-
Sets the logical bean name that replaces any occurrences of
"@managed-bean-name" within a binding expression.
- setManagedBeanName(String) - Method in class org.apache.shale.clay.taglib.ClayTag
-
Name of the managed bean that is dynamically resolved.
- setName(String) - Method in class org.apache.shale.clay.config.beans.SymbolBean
-
Sets the name of the attribute.
- setName(String) - Method in class org.apache.shale.clay.parser.Node
-
Sets the node name.
- setName(String) - Method in class org.apache.shale.clay.taglib.SymbolTag
-
Sets the
name
of the symbol.
- setNode(Node) - Method in class org.apache.shale.clay.parser.builder.chain.BuilderRuleContext
-
Sets the current html
Node
.
- setParent(UIComponent) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the parent of the child.
- setParent(Node) - Method in class org.apache.shale.clay.parser.Node
-
Sets the parent node.
- setPrefix(String) - Method in class org.apache.shale.clay.parser.builder.chain.JsfDefaultBuilderRule
-
Sets the namespace preix that will override the template
nodeds qname.
- setPrefix(String) - Method in class org.apache.shale.clay.parser.builder.JsfDefaultBuilder
-
Sets the namespace preix that will override the template
nodeds qname.
- setProperties(UIComponent) - Method in class org.apache.shale.clay.taglib.ClayTag
-
This method is invoked by the super and its purpose it
to push tag attributes to corresponding component property
values.
- setQname(String) - Method in class org.apache.shale.clay.parser.Node
-
Sets the qualified node name.
- setRenderId(int) - Method in class org.apache.shale.clay.config.beans.ElementBean
-
Sets an integer id that is used to order within the
ComponentBean
children
set.
- setRootElement(ComponentBean) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets the root config object used to construct the
Clay
component subtree.
- setSeparator(Character) - Method in class org.apache.shale.clay.convert.StringArrayConverter
-
- setShapeValidator(String) - Method in class org.apache.shale.clay.component.Clay
-
Sets the
validator
signature event that is invoked when
the component metadata is retrieved.
- setShapeValidator(String) - Method in class org.apache.shale.clay.taglib.ClayTag
-
Sets the expression literal defining the validator event method binding.
- setStart(boolean) - Method in class org.apache.shale.clay.parser.Node
-
Sets a boolean flag indicating that the node is a beginning marker.
- setSymbols(Map) - Method in class org.apache.shale.clay.component.chain.ClayContext
-
Sets a Map containing replacement symbols
within meta-component attributes.
- setValidators(Collection) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Adds a collection of
ValidatorBean
to the validator
set.
- setValue(String) - Method in class org.apache.shale.clay.config.beans.SymbolBean
-
Sets the value of the attribute.
- setValue(String) - Method in class org.apache.shale.clay.taglib.SymbolTag
-
Sets the
value
for the symbol.
- setValueChangeListeners(Collection) - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
Merges a collection of
ValueChangeListenerBean
where items in the
source collection with the same jsfid
will override items
in the target set with the same identifier.
- setVar(String) - Method in class org.apache.shale.clay.component.LoadBundle
-
Sets the name of a request scope attribute under which the resource
bundle will be exposed as a Map.
- setWellFormed(boolean) - Method in class org.apache.shale.clay.parser.Node
-
Sets a boolean flag that is
true
if the node has a
beginning and ending marker.
- SpanBuilderRule - Class in org.apache.shale.clay.parser.builder.chain
-
- SpanBuilderRule() - Constructor for class org.apache.shale.clay.parser.builder.chain.SpanBuilderRule
-
- START_CHARSET_TOKEN - Static variable in class org.apache.shale.clay.parser.Parser
-
The start of the comment token used to override the template
encoding type.
- StringArrayConverter - Class in org.apache.shale.clay.convert
-
Converts a
String
to a String[]
or
vise versa.
- StringArrayConverter() - Constructor for class org.apache.shale.clay.convert.StringArrayConverter
-
- suffixes - Variable in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
The suffixes used to identify that a jsfid is a template style of
composition.
- SymbolBean - Class in org.apache.shale.clay.config.beans
-
A symbol represents a variable replaced in a
JSF binding expression.
- SymbolBean() - Constructor for class org.apache.shale.clay.config.beans.SymbolBean
-
- SymbolTag - Class in org.apache.shale.clay.taglib
-
This Tag is used to add replacement symbols to the
Clay
component.
- SymbolTag() - Constructor for class org.apache.shale.clay.taglib.SymbolTag
-
T
- TemplateComponentConfigBean - Class in org.apache.shale.clay.config.beans
-
This ConfigBean is responsible for handling full XML views.
- TemplateComponentConfigBean() - Constructor for class org.apache.shale.clay.config.beans.TemplateComponentConfigBean
-
- TemplateConfigBean - Class in org.apache.shale.clay.config.beans
-
The second type of top-level object pool.
- TemplateConfigBean() - Constructor for class org.apache.shale.clay.config.beans.TemplateConfigBean
-
- TextareaBuilderRule - Class in org.apache.shale.clay.parser.builder.chain
-
- TextareaBuilderRule() - Constructor for class org.apache.shale.clay.parser.builder.chain.TextareaBuilderRule
-
- TimeZoneConverter - Class in org.apache.shale.clay.convert
-
Converts a time zone id literal string into the
TimeZone
and back to a string.
- TimeZoneConverter() - Constructor for class org.apache.shale.clay.convert.TimeZoneConverter
-
- Token - Interface in org.apache.shale.clay.parser
-
A
Token
identifies an offset range
within the document.
- toString() - Method in class org.apache.shale.clay.config.beans.AttributeBean
-
- toString() - Method in class org.apache.shale.clay.config.beans.ComponentBean
-
- toString() - Method in class org.apache.shale.clay.config.beans.ElementBean
-
- toString() - Method in class org.apache.shale.clay.config.beans.SymbolBean
-
- toString() - Method in class org.apache.shale.clay.parser.Node
-
U
- unassignParent(ComponentBean) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Recursively called to unassign isA and hasA parent
relationships.
V
- validate(String, String, PageData) - Method in class org.apache.shale.clay.taglib.ClayTagValidator
-
Validates the page for a directive with a uri of
"http://shale.apache.org/shale/clay-plugin".
- ValidatorBean - Class in org.apache.shale.clay.config.beans
-
This meta component will be used to construct a JSF
Validator
.
- ValidatorBean() - Constructor for class org.apache.shale.clay.config.beans.ValidatorBean
-
- validMoniker(String) - Method in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Called by the
ConfigBeanFactory
to determine if this
instance of ConfigBean
can handle finding the ConfigBean
from the jsfid
.
- validMoniker(String) - Method in interface org.apache.shale.clay.config.beans.ConfigBean
-
- validMoniker(String) - Method in class org.apache.shale.clay.config.beans.TemplateComponentConfigBean
-
Overrides the super call to change the condition of the filter.
- validMoniker(String) - Method in class org.apache.shale.clay.config.beans.TemplateConfigBean
-
Overrides the super call to change the condition of the filter.
- value(Context) - Method in class org.apache.shale.clay.config.beans.ConfigDefinitionsWatchdogFilter
-
Return the servlet path (if any) concatenated with the path info
(if any) for this request.
- ValueChangeListenerBean - Class in org.apache.shale.clay.config.beans
-
This meta component will be used to construct a JSF
ValueChangeListener
.
- ValueChangeListenerBean() - Constructor for class org.apache.shale.clay.config.beans.ValueChangeListenerBean
-
- VerbatimBuilder - Class in org.apache.shale.clay.parser.builder
-
This is the default
Builder
that will create a ElementBean
having characteristics like the JSP verbatim tag.
- VerbatimBuilder() - Constructor for class org.apache.shale.clay.parser.builder.VerbatimBuilder
-
- VIEW_MAPPER - Static variable in class org.apache.shale.clay.faces.ClayViewHandler
-
Application scope attribute under which the
ViewControllerMapper
for translating view identifiers
to class names of the corresponding ViewController
is stored.
- VoidBuilder - Class in org.apache.shale.clay.parser.builder
-
This is a
Builder
that will create a void ElementBean
.
- VoidBuilder() - Constructor for class org.apache.shale.clay.parser.builder.VoidBuilder
-
W
- watchDogs - Variable in class org.apache.shale.clay.config.beans.ComponentConfigBean
-
Map of
ComponentConfigBean.WatchDog
that watches the configuration files looking for changes.
- writeState(FacesContext) - Method in class org.apache.shale.clay.faces.ClayViewHandler
-
Invokes the original view handler's writeState.
A B C D E F G I J L M N O P R S T U V W
Copyright © 2004-2013 Apache Software Foundation. All Rights Reserved.