|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXGroup
public class UIXGroup
The group component is an invisible control that aggregates semantically-related children; the group itself has no associated client representation (visual or API). Some parent components may have special representation for groups like adding separators around the group but this is a special case and is not always rendered this way. In most cases, only the children of the group will be rendered directly to the page. There will be no layout applied to the children so the natural layout behavior of the underlying HTML elements will apply. If you require a more predictable layout, you should use a layout component such as panelGroupLayout.
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static String |
END_BOUNDARY_DONT_CARE
|
static String |
END_BOUNDARY_HIDE
|
static PropertyKey |
END_BOUNDARY_KEY
|
static String |
END_BOUNDARY_SHOW
|
static String |
START_BOUNDARY_DONT_CARE
|
static String |
START_BOUNDARY_HIDE
|
static PropertyKey |
START_BOUNDARY_KEY
|
static String |
START_BOUNDARY_SHOW
|
static PropertyKey |
TITLE_KEY
|
static FacesBean.Type |
TYPE
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
|
UIXGroup()
Construct an instance of the UIXGroup. |
protected |
UIXGroup(String rendererType)
Construct an instance of the UIXGroup. |
Method Summary | ||
---|---|---|
void |
encodeChildren(javax.faces.context.FacesContext context)
Renders the children in their raw form. |
|
protected FacesBean.Type |
getBeanType()
|
|
String |
getEndBoundary()
Gets indicates if a visual group end boundary is desired. |
|
String |
getFamily()
|
|
boolean |
getRendersChildren()
Overridden to return true. |
|
String |
getStartBoundary()
Gets indicates if a visual group start boundary is desired. |
|
String |
getTitle()
Gets a title value for the group. |
|
boolean |
isFlatteningChildren(javax.faces.context.FacesContext context)
Returns true if this FlattenedComponent is currently flattening its children |
|
|
processFlattenedChildren(javax.faces.context.FacesContext context,
ComponentProcessingContext cpContext,
ComponentProcessor<S> childProcessor,
S callBackContext)
Sets up the grouping context and processes all of the UIXGroup's children |
|
void |
setEndBoundary(String endBoundary)
Sets indicates if a visual group end boundary is desired. |
|
void |
setStartBoundary(String startBoundary)
Sets indicates if a visual group start boundary is desired. |
|
void |
setTitle(String title)
Sets a title value for the group. |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String START_BOUNDARY_SHOW
public static final String START_BOUNDARY_HIDE
public static final String START_BOUNDARY_DONT_CARE
public static final String END_BOUNDARY_SHOW
public static final String END_BOUNDARY_HIDE
public static final String END_BOUNDARY_DONT_CARE
public static final FacesBean.Type TYPE
public static final PropertyKey START_BOUNDARY_KEY
public static final PropertyKey END_BOUNDARY_KEY
public static final PropertyKey TITLE_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public UIXGroup()
protected UIXGroup(String rendererType)
Method Detail |
---|
public boolean getRendersChildren()
getRendersChildren
in class UIXComponentBase
public <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context, ComponentProcessingContext cpContext, ComponentProcessor<S> childProcessor, S callBackContext) throws IOException
processFlattenedChildren
in interface FlattenedComponent
context
- Current FacesContextcpContext
- ComponentProcesingContext represetning the current child iteration statechildProcessor
- ComponentProcessor to call for each flattened childcallBackContext
- childProcessor-specific context to be passed on each call to the
childProcessor
true
if this FlattenedComponent actually processed any children
IOException
- if an error occurs while processing childrenUIXComponent.processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, UIComponent, Object)
,
UIXComponent.processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, Iterable, Object)
,
FlattenedComponent.isFlatteningChildren(javax.faces.context.FacesContext)
public boolean isFlatteningChildren(javax.faces.context.FacesContext context)
true
if this FlattenedComponent is currently flattening its children
isFlatteningChildren
in interface FlattenedComponent
context
- FacesContext
true
if this FlattenedComponent is currently flattening its childrenFlattenedComponent.processFlattenedChildren(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.component.ComponentProcessingContext, org.apache.myfaces.trinidad.component.ComponentProcessor, S)
public void encodeChildren(javax.faces.context.FacesContext context) throws IOException
encodeChildren
in class UIXComponentBase
context
- the FacesContext
IOException
- if there is an error encoding the childrenpublic final String getStartBoundary()
public final void setStartBoundary(String startBoundary)
startBoundary
- the new startBoundary valuepublic final String getEndBoundary()
public final void setEndBoundary(String endBoundary)
endBoundary
- the new endBoundary valuepublic final String getTitle()
public final void setTitle(String title)
title
- the new title valuepublic String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |