| java.lang.Object
 uk.org.ponder.rsf.components.UIComponent
All known Subclasses: uk.org.ponder.rsf.components.UIListMember, uk.org.ponder.rsf.components.UISwitch, uk.org.ponder.rsf.components.UILink, uk.org.ponder.rsf.components.UIReplicator, uk.org.ponder.rsf.components.UIVerbatim, uk.org.ponder.rsf.components.UIError, uk.org.ponder.rsf.components.UIBound, uk.org.ponder.rsf.components.UIParameterHolder, uk.org.ponder.rsf.components.UISelect,
| UIComponent | | public class UIComponent (Code) | | UIComponent is the base of the entire RSF component hierarchy. Components
derived from this class may either be containers derived from UIContainer,
or else leaf components peering with target dialect tags.
Note that Components form a containment hierarchy ONLY to allow nested
repetitive domains. This class is mutually referential with UIContainer.
author:
Antranig Basman (antranig@caret.cam.ac.uk) |
| Field Summary | |
| public String | ID
This ID corresponds to the rsf:id in the view template, and is parsed
by use of the class SplitID. | | public DecoratorList | decorators
A list of "decorators" which alter the rendering behaviour of this
component, orthogonal to its binding behaviour. | | public UIContainer | parent
The containing parent of this component, or null for the
UIContainer representing the view root. |
| Method Summary | |
| public UIComponent | decorate(UIDecorator decorator)
Add the supplied decorator to the list for this component, initialising
the list if necessary. | | public String | getFullID()
The algorithm used here must deterministically generate a string ID
globally unique within the containing component tree (the View), by
appending path components derived from IDs and local IDs found at each
level of UIContainer. | | public void | updateFullID(String fullID)
Updates the full ID of this component with the supplied value. |
| ID | | public String ID(Code) | | This ID corresponds to the rsf:id in the view template, and is parsed
by use of the class SplitID.
|
| decorators | | public DecoratorList decorators(Code) | | A list of "decorators" which alter the rendering behaviour of this
component, orthogonal to its binding behaviour. Usually null
|
| parent | | public UIContainer parent(Code) | | The containing parent of this component, or null for the
UIContainer representing the view root.
|
| decorate | | public UIComponent decorate(UIDecorator decorator)(Code) | | Add the supplied decorator to the list for this component, initialising
the list if necessary.
|
| getFullID | | public String getFullID()(Code) | | The algorithm used here must deterministically generate a string ID
globally unique within the containing component tree (the View), by
appending path components derived from IDs and local IDs found at each
level of UIContainer. This algorithm should be "accessible" to simple
environments such as XSLTs since they will need to operate it to generate
inter-component references within a view (for example to express any
EL dependencies).
The structure of the ID forms colon-separated "triples", one for each
container in the path, ending with the rsf:id of any leaf component, e.g.
ID1-prefix:ID1-suffix:localID1:ID2-prefix:ID2-suffix:localID2:etc.
|
| updateFullID | | public void updateFullID(String fullID)(Code) | | Updates the full ID of this component with the supplied value. This
is an "emergency" method to be used only as a last resort. Within RSF
it is necessary to ensure that UIBound components arising as direct children
of "composite" parents can have their IDs set correctly before value
fixup.
|
|
|