public abstract class PartialRichDeck
extends org.apache.myfaces.trinidad.component.UIXPanel
implements javax.faces.component.behavior.ClientBehaviorHolder
// Action listener for navigating to the 1st card of a deck. public void animateToFirstCard(ActionEvent e) { UIComponent eventComponent = e.getComponent(); _animateDeckDisplayedChild(eventComponent, 0); } // Action listener for navigating to the 2nd card of a deck. public void animateToSecondCard(ActionEvent e) { UIComponent eventComponent = e.getComponent(); _animateDeckDisplayedChild(eventComponent, 1); } // Animate the display of a deck child. private void _animateDeckDisplayedChild( UIComponent eventComponent, int newDisplayedChildIndex) { // Find the nearest deck ancestor: RichDeck deck = null; String eventComponentId = eventComponent.getId(); while (deck == null) { if (eventComponent == null) { System.err.println("Unable to locate a deck ancestor from id " + eventComponentId); return; } else if (eventComponent instanceof RichDeck) { deck = (RichDeck)eventComponent; break; } eventComponent = eventComponent.getParent(); } String newDisplayedChild = deck.getChildren().get(newDisplayedChildIndex).getId(); // Update the displayedChild: deck.setDisplayedChild(newDisplayedChild); // Add this component as a partial target: RequestContext rc = RequestContext.getCurrentInstance(); rc.addPartialTarget(deck); }In order to choose what the transition will look like when changing the deck's displayedChild, place one or two af:transition tags inside of the af:deck tag. This tag will let you choose an animation style and what kind of transition will trigger that type of animation. In order for a transition to take effect, the deck must be redrawn but not some ancestor of the deck because if an ancestor is redrawn the old state for the deck will be lost (nothing to transition from). <p/> Many of the transition animations will give a different effect based on the width and height of the deck component. In most cases, you will either want to explicitly assign a width and height inlineStyle to constrain the dimensions of the deck or place the deck in a container that provides dimensions. For example, if the deck were displaying one playing card at a time, you would want your deck's dimensions to match the dimensions of the playing card. If you allowed the deck to display using the full width of the page, a horizontal flip transition will look funny because the axis of the flip will be the middle of the deck, not the middle of the playing card. <p/> Some of the transition animations can cause content to bleed outside of the deck's dimensions during the transition animation. If this effect is undesirable for your use case, you can add an "overflow:hidden" inlineStyle. When using this style, make sure your deck is constrained to a width and height (or is being stretched by an ancestor component) or else the user won't be able to see it because the deck will display with a zero pixel height. <p/> Transition Trigger Types
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. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static String |
DIMENSIONS_FROM_AUTO |
static String |
DIMENSIONS_FROM_CHILDREN |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static String |
DIMENSIONS_FROM_PARENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISPLAYED_CHILD_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static String |
LANDMARK_BANNER |
static String |
LANDMARK_COMPLEMENTARY |
static String |
LANDMARK_CONTENTINFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LANDMARK_KEY |
static String |
LANDMARK_MAIN |
static String |
LANDMARK_NAVIGATION |
static String |
LANDMARK_NONE |
static String |
LANDMARK_SEARCH |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Modifier | Constructor and Description |
---|---|
protected |
PartialRichDeck(String rendererType)
Construct an instance of the PartialRichDeck.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
String |
getDimensionsFrom()
Gets
|
String |
getDisplayedChild()
Gets indicates the id of the child component that is currently displayed; if not provided or if no match is found, no child will be displayed.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getLandmark()
Gets specifies the WAI-ARIA landmark role for this deck.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets the short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
Set<String> |
getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setClientAttributes(Set clientAttributes)
Sets a set of client attribute names.
|
void |
setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated.
|
void |
setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setDimensionsFrom(String dimensionsFrom)
Sets
|
void |
setDisplayedChild(String displayedChild)
Sets indicates the id of the child component that is currently displayed; if not provided or if no match is found, no child will be displayed.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setLandmark(String landmark)
Sets specifies the WAI-ARIA landmark role for this deck.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the component.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setUnsecure(Set<String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
void |
setVisible(boolean visible)
Sets the visibility of the component.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String DIMENSIONS_FROM_AUTO
public static final String DIMENSIONS_FROM_CHILDREN
public static final String DIMENSIONS_FROM_PARENT
public static final String LANDMARK_NONE
public static final String LANDMARK_BANNER
public static final String LANDMARK_COMPLEMENTARY
public static final String LANDMARK_CONTENTINFO
public static final String LANDMARK_MAIN
public static final String LANDMARK_NAVIGATION
public static final String LANDMARK_SEARCH
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LANDMARK_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAYED_CHILD_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
protected PartialRichDeck(String rendererType)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the root element of the deck will come from:
public final void setDimensionsFrom(String dimensionsFrom)
determines how the component will handle geometry management. This specifies where the dimensions of the root element of the deck will come from:
dimensionsFrom
- the new dimensionsFrom valuepublic final String getLandmark()
public final void setLandmark(String landmark)
landmark
- the new landmark valuepublic final String getDisplayedChild()
public final void setDisplayedChild(String displayedChild)
displayedChild
- the new displayedChild valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel