All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.myfaces.trinidad.component.UIXPage Maven / Gradle / Ivy

// WARNING: This file was automatically generated. Do not edit it directly,
//          or you will lose your changes.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
*/
package org.apache.myfaces.trinidad.component;

import java.io.IOException;
import java.util.Iterator;
import java.util.Map;
import javax.el.MethodExpression;
import javax.faces.component.UIComponent;
import javax.faces.component.visit.VisitCallback;
import javax.faces.component.visit.VisitContext;
import javax.faces.component.visit.VisitHint;
import javax.faces.context.FacesContext;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import javax.faces.event.PhaseId;
import org.apache.myfaces.trinidad.bean.FacesBean;
import org.apache.myfaces.trinidad.bean.PropertyKey;
import org.apache.myfaces.trinidad.event.RowDisclosureListener;
import org.apache.myfaces.trinidad.model.CollectionModel;
import org.apache.myfaces.trinidad.model.RowKeySet;
import org.apache.myfaces.trinidad.model.RowKeySetTreeImpl;
import org.apache.myfaces.trinidad.model.TreeModel;
import org.apache.myfaces.trinidad.util.ComponentUtils;

/**
 *
 * 
 *           A Page component uses a MenuModel and a stamp to render navigation items.
 *           
 *
 * 

Events:

* * * * * * * * * * * * * * * * *
TypePhasesDescription
org.apache.myfaces.trinidad.event.RowDisclosureEventApply
Request
Values
Invoke
Application
The expansion event is generated for a table when the detail facet of a row is expanded or collapsed. For tree or a treeTable, the expansion event is generated when tree nodes are expanded or collapsed.
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke
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.
*/ public class UIXPage extends UIXNavigationHierarchy { static public final FacesBean.Type TYPE = new FacesBean.Type( UIXNavigationHierarchy.TYPE); static public final PropertyKey ROW_DISCLOSURE_LISTENER_KEY = TYPE.registerKey("rowDisclosureListener", MethodExpression.class); static public final PropertyKey DISCLOSED_ROW_KEYS_KEY = TYPE.registerKey("disclosedRowKeys", RowKeySet.class, null, 0, PropertyKey.Mutable.OFTEN); static public final PropertyKey VALUE_KEY = TYPE.registerKey("value", Object.class, null, 0, PropertyKey.Mutable.SOMETIMES); static public final PropertyKey VAR_STATUS_KEY = TYPE.registerKey("varStatus", String.class, PropertyKey.CAP_NOT_BOUND); static public final PropertyKey IMMEDIATE_KEY = TYPE.registerKey("immediate", Boolean.class, Boolean.FALSE); static public final String NODE_STAMP_FACET = "nodeStamp"; static public final String COMPONENT_FAMILY = "org.apache.myfaces.trinidad.Page"; static public final String COMPONENT_TYPE = "org.apache.myfaces.trinidad.Page"; /** * Construct an instance of the UIXPage. */ public UIXPage() { super("org.apache.myfaces.trinidad.BasePage"); } /** * Sets the phaseID of UI events depending on the "immediate" property. */ @Override public void queueEvent(FacesEvent event) { TableUtils.__handleQueueEvent(this, event); super.queueEvent(event); } /** * Delivers an event. * @param event * @throws javax.faces.event.AbortProcessingException */ @Override public void broadcast(FacesEvent event) throws AbortProcessingException { HierarchyUtils.__handleBroadcast(this, event, getDisclosedRowKeys(), getRowDisclosureListener()); super.broadcast(event); } @Override public CollectionModel createCollectionModel(CollectionModel current, Object value) { TreeModel model = (TreeModel)super.createCollectionModel(current, value); RowKeySet treeState = getDisclosedRowKeys(); treeState.setCollectionModel(model); return model; } @Override @SuppressWarnings("unchecked") protected void processFacetsAndChildren( FacesContext context, PhaseId phaseId) { Object oldPath = getRowKey(); setRowKey(null); HierarchyUtils.__iterateOverTree(context, phaseId, this, getDisclosedRowKeys(), false); setRowKey(oldPath); // process the children TableUtils.__processChildren(context, this, phaseId); Map facets = getFacets(); Iterator facetKeys = facets.keySet().iterator(); while(facetKeys.hasNext()) { String facetKey = facetKeys.next(); if (!"nodeStamp".equals(facetKey)) { processComponent(context, facets.get(facetKey), phaseId); } } } @Override protected boolean visitChildren( VisitContext visitContext, VisitCallback callback) { if (ComponentUtils.isSkipIterationVisit(visitContext)) { return visitChildrenWithoutIterating(visitContext, callback); } else { return _visitChildrenIterating(visitContext, callback); } } private boolean _visitChildrenIterating( VisitContext visitContext, VisitCallback callback) { boolean done = visitData(visitContext, callback); if (!done) { // process the children int childCount = getChildCount(); if (childCount > 0) { for (UIComponent child : getChildren()) { done = UIXComponent.visitTree(visitContext, child, callback); if (done) break; } } // process the non-stamp facet children if (!done) { // Visit the facets except for the node stamp int facetCount = getFacetCount(); if (facetCount > 0) { UIComponent nodeStamp = getNodeStamp(); // if our only facet is the node stamp, we don't need to do this if ((facetCount > 1) || (nodeStamp == null)) { for (UIComponent facet : getFacets().values()) { // ignore the nodeStamp facet, since it is stamped if (facet != nodeStamp) { if (UIXComponent.visitTree(visitContext, facet, callback)) { done = true; break; } } } } } } } return done; } @Override protected boolean visitData( VisitContext visitContext, VisitCallback callback) { Object oldPath = getRowKey(); // if we are only visiting rendered stamps, then pass in the disclosed row keys, otherwise // pass in null, indicating that all row keys should be visited RowKeySet disclosedRowKeys = (visitContext.getHints().contains(VisitHint.SKIP_UNRENDERED)) ? getDisclosedRowKeys() : null; setRowKey(null); boolean done; try { done = visitHierarchy(visitContext, callback, getStamps(), disclosedRowKeys); } finally { setRowKey(oldPath); } return done; } @Override void __encodeBegin(FacesContext context) throws IOException { HierarchyUtils.__handleEncodeBegin(this, getDisclosedRowKeys()); super.__encodeBegin(context); } @Override void __init() { super.__init(); if (getDisclosedRowKeys() == null) setDisclosedRowKeys(new RowKeySetTreeImpl()); } @Override protected FacesBean createFacesBean(String rendererType) { return new RowKeyFacesBeanWrapper(super.createFacesBean(rendererType)); } private class RowKeyFacesBeanWrapper extends FacesBeanWrapper { private boolean _retrievingDisclosedRows = false; RowKeyFacesBeanWrapper(FacesBean bean) { super(bean); } @Override public Object getProperty(PropertyKey key) { Object value = super.getProperty(key); if (key == DISCLOSED_ROW_KEYS_KEY && !_retrievingDisclosedRows && value instanceof RowKeySet) { // Ensure that when we are retrieving and setting the collection model, this property // is not asked for which would create an infinite loop _retrievingDisclosedRows = true; try { RowKeySet rowKeys = (RowKeySet) value; // row key sets need the most recent collection model, but there is no one common entry // point to set this on the set besides when code asks for the value from the bean __flushCachedModel(); //insist that we populate with the very lastest instance of the collection model rowKeys.setCollectionModel(getCollectionModel()); } finally { _retrievingDisclosedRows = false; } } return value; } @Override public Object saveState(FacesContext context) { RowKeySet rowKeys = (RowKeySet)super.getProperty(DISCLOSED_ROW_KEYS_KEY); if (rowKeys != null) { // make sure the set does not pin the model in memory rowKeys.setCollectionModel(null); } return super.saveState(context); } } /** * the component to use to stamp each element in the * menu. A CommandNavigationItem is expected. */ final public UIComponent getNodeStamp() { return getFacet(NODE_STAMP_FACET); } /** * the component to use to stamp each element in the * menu. A CommandNavigationItem is expected. */ @SuppressWarnings("unchecked") final public void setNodeStamp(UIComponent nodeStampFacet) { getFacets().put(NODE_STAMP_FACET, nodeStampFacet); } /** * Gets a method reference to an ExpansionListener * * @return the new rowDisclosureListener value */ final public MethodExpression getRowDisclosureListener() { return (MethodExpression)getProperty(ROW_DISCLOSURE_LISTENER_KEY); } /** * Sets a method reference to an ExpansionListener * * @param rowDisclosureListener the new rowDisclosureListener value */ final public void setRowDisclosureListener(MethodExpression rowDisclosureListener) { setProperty(ROW_DISCLOSURE_LISTENER_KEY, (rowDisclosureListener)); } /** * Gets the set of disclosed rows for this component. * Each entry in the set is a rowKey. * * @return the new disclosedRowKeys value */ final public RowKeySet getDisclosedRowKeys() { return (RowKeySet)getProperty(DISCLOSED_ROW_KEYS_KEY); } /** * Sets the set of disclosed rows for this component. * Each entry in the set is a rowKey. * * @param disclosedRowKeys the new disclosedRowKeys value */ final public void setDisclosedRowKeys(RowKeySet disclosedRowKeys) { setProperty(DISCLOSED_ROW_KEYS_KEY, (disclosedRowKeys)); } /** * Gets the hierarchy of menu data - must be of type * org.apache.myfaces.trinidad.model.MenuModel * * @return the new value value */ final public Object getValue() { return getProperty(VALUE_KEY); } /** * Sets the hierarchy of menu data - must be of type * org.apache.myfaces.trinidad.model.MenuModel * * @param value the new value value */ final public void setValue(Object value) { setProperty(VALUE_KEY, (value)); } /** * Gets * Name of the EL variable used to reference the varStatus information. * Once this component has completed rendering, this variable is * removed (or reverted back to its previous value). * The VarStatus provides contextual information about the state of the * component to EL expressions. For components that iterate, varStatus * also provides loop counter information. Please see the this * component's documentation for the specific properties on the varStatus. * The common properties on varStatus include:
  • "model" - returns the CollectionModel for this component
  • "index" - returns the zero based row index
* * @return the new varStatus value */ final public String getVarStatus() { return ComponentUtils.resolveString(getProperty(VAR_STATUS_KEY)); } /** * Sets * Name of the EL variable used to reference the varStatus information. * Once this component has completed rendering, this variable is * removed (or reverted back to its previous value). * The VarStatus provides contextual information about the state of the * component to EL expressions. For components that iterate, varStatus * also provides loop counter information. Please see the this * component's documentation for the specific properties on the varStatus. * The common properties on varStatus include:
  • "model" - returns the CollectionModel for this component
  • "index" - returns the zero based row index
* * @param varStatus the new varStatus value */ final public void setVarStatus(String varStatus) { setProperty(VAR_STATUS_KEY, (varStatus)); } /** * Gets whether data validation * should be skipped when row disclosure * events are generated by this component. * * When immediate is false (the default), events will * be delivered during the Invoke Application phase, which * will trigger validation. When set to true, events * will be executed during the Apply Request Values phase. * * @return the new immediate value */ final public boolean isImmediate() { return ComponentUtils.resolveBoolean(getProperty(IMMEDIATE_KEY), false); } /** * Sets whether data validation * should be skipped when row disclosure * events are generated by this component. * * When immediate is false (the default), events will * be delivered during the Invoke Application phase, which * will trigger validation. When set to true, events * will be executed during the Apply Request Values phase. * * @param immediate the new immediate value */ final public void setImmediate(boolean immediate) { setProperty(IMMEDIATE_KEY, immediate ? Boolean.TRUE : Boolean.FALSE); } /** * Adds a rowDisclosure listener. * * @param listener the rowDisclosure listener to add */ final public void addRowDisclosureListener( RowDisclosureListener listener) { addFacesListener(listener); } /** * Removes a rowDisclosure listener. * * @param listener the rowDisclosure listener to remove */ final public void removeRowDisclosureListener( RowDisclosureListener listener) { removeFacesListener(listener); } /** * Returns an array of attached rowDisclosure listeners. * * @return an array of attached rowDisclosure listeners. */ final public RowDisclosureListener[] getRowDisclosureListeners() { return (RowDisclosureListener[])getFacesListeners(RowDisclosureListener.class); } @Override public String getFamily() { return COMPONENT_FAMILY; } @Override protected FacesBean.Type getBeanType() { return TYPE; } /** * Construct an instance of the UIXPage. */ protected UIXPage( String rendererType ) { super(rendererType); } static { TYPE.lockAndRegister("org.apache.myfaces.trinidad.Page","org.apache.myfaces.trinidad.BasePage"); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy