com.sun.faces.component.behavior.AjaxBehaviors Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.faces Show documentation
Show all versions of javax.faces Show documentation
This is the master POM file for Oracle's Implementation of the JSF 2.2 Specification.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.faces.component.behavior;
import java.io.Serializable;
import java.util.ArrayDeque;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.faces.application.Application;
import javax.faces.component.behavior.AjaxBehavior;
import javax.faces.component.behavior.ClientBehavior;
import javax.faces.component.behavior.ClientBehaviorHint;
import javax.faces.component.behavior.ClientBehaviorHolder;
import javax.faces.context.FacesContext;
/**
* An instance of the class is used to
* manage {@link AjaxBehavior} instances.
*
* @since 2.0
*/
public class AjaxBehaviors implements Serializable {
private static final String AJAX_BEHAVIORS = "javax.faces.component.AjaxBehaviors";
private ArrayDeque behaviorStack = null;
public AjaxBehaviors() {
behaviorStack = new ArrayDeque();
}
// Returns the AjaxBehaviors instance, creating it if necessary.
public static AjaxBehaviors getAjaxBehaviors(FacesContext context,
boolean createIfNull) {
Map attrs = context.getAttributes();
AjaxBehaviors ajaxBehaviors = (AjaxBehaviors)attrs.get(AJAX_BEHAVIORS);
if ((ajaxBehaviors == null) && createIfNull) {
ajaxBehaviors = new AjaxBehaviors();
attrs.put(AJAX_BEHAVIORS, ajaxBehaviors);
}
return ajaxBehaviors;
}
// Adds AjaxBehaviors to the specified ClientBehaviorHolder
public void addBehaviors(FacesContext context,
ClientBehaviorHolder behaviorHolder) {
if ((behaviorStack == null) || behaviorStack.isEmpty()){
return;
}
// Loop over pushed Behaviors and add to the ClientBehaviorHolder.
// Note that we add most recently pushed behaviors first. That
// way the nearest behaviors take precedence. Behaviors that were
// pushed earlier won't be added since we'll already have a
// submitting behavior attached.
Iterator descendingIter = behaviorStack.descendingIterator();
while (descendingIter.hasNext()) {
descendingIter.next().addBehavior(context, behaviorHolder);
}
}
/**
* Push the {@link AjaxBehavior} instance onto the List.
*
* @param ajaxBehavior the {@link AjaxBehavior} instance
* @param eventName the name of the event that the behavior is associated
* with.
*
* @since 2.0
*/
public void pushBehavior(FacesContext context,
AjaxBehavior ajaxBehavior,
String eventName) {
behaviorStack.add(new BehaviorInfo(context, ajaxBehavior, eventName));
}
/**
* Pop the last {@link AjaxBehavior} instance
* from the List.
*
* @since 2.0
*/
public void popBehavior() {
if (behaviorStack.size() > 0) {
behaviorStack.removeLast();
}
}
// Helper class for storing and creating/applying inherited
// AjaxBehaviors
public static class BehaviorInfo implements Serializable {
private String eventName;
private Object behaviorState;
private static final long serialVersionUID = -7679229822647712959L;
public BehaviorInfo(FacesContext context,
AjaxBehavior ajaxBehavior,
String eventName) {
this.eventName = eventName;
// We don't actually need the AjaxBehavior - just
// its state.
behaviorState = ajaxBehavior.saveState(context);
}
public void addBehavior(FacesContext context,
ClientBehaviorHolder behaviorHolder) {
String myEventName = this.eventName;
if (myEventName == null) {
myEventName = behaviorHolder.getDefaultEventName();
// No event name, default or otherwise - we're done
if (myEventName == null) {
return;
}
}
// We only add the
if (shouldAddBehavior(behaviorHolder, myEventName)) {
ClientBehavior behavior = createBehavior(context);
behaviorHolder.addClientBehavior(myEventName, behavior);
}
}
// Tests whether we should add an AjaxBehavior to the specified
// ClientBehaviorHolder/event name.
private boolean shouldAddBehavior(ClientBehaviorHolder behaviorHolder,
String eventName) {
// First need to make sure that this ClientBehaviorHolder
// supports the specified event type.
if (!behaviorHolder.getEventNames().contains(eventName)) {
return false;
}
// Check for a submitting behavior already attached.
// If we've already got one, we don't add another.
Map> allBehaviors =
behaviorHolder.getClientBehaviors();
List eventBehaviors = allBehaviors.get(eventName);
if ((eventBehaviors == null) || (eventBehaviors.isEmpty())) {
return true;
}
for (ClientBehavior behavior : eventBehaviors) {
Set hints = behavior.getHints();
if (hints.contains(ClientBehaviorHint.SUBMITTING)) {
return false;
}
}
return true;
}
// Creates the AjaxBehavior
private ClientBehavior createBehavior(FacesContext context) {
Application application = context.getApplication();
// Re-create the instance via the Application
AjaxBehavior behavior = (AjaxBehavior)application.createBehavior(
AjaxBehavior.BEHAVIOR_ID);
// And re-initialize its state
behavior.restoreState(context, behaviorState);
return behavior;
}
private BehaviorInfo() {
}
}
}