javax.faces.application.Application Maven / Gradle / Ivy
Show all versions of myfaces-api Show documentation
/*
* Copyright 2004 The Apache Software Foundation.
*
* Licensed 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 javax.faces.application;
import javax.faces.FacesException;
import javax.faces.el.ReferenceSyntaxException;
import java.util.Collection;
import java.util.Iterator;
import java.util.Locale;
/**
* Holds webapp-wide resources for a JSF application. There is a single one of
* these for a web application, accessable via
*
* FacesContext.getCurrentInstance().getApplication()
*
* In particular, this provides a factory for UIComponent objects.
* It also provides convenience methods for creating ValueBinding objects.
*
* See Javadoc of JSF Specification
*
* @author Manfred Geiler (latest modification by $Author: skitching $)
* @version $Revision: 369298 $ $Date: 2006-01-16 01:21:29 +0000 (Mon, 16 Jan 2006) $
*/
public abstract class Application
{
public abstract javax.faces.event.ActionListener getActionListener();
public abstract void setActionListener(javax.faces.event.ActionListener listener);
public abstract Locale getDefaultLocale();
public abstract void setDefaultLocale(Locale locale);
public abstract String getDefaultRenderKitId();
public abstract void setDefaultRenderKitId(String renderKitId);
public abstract String getMessageBundle();
public abstract void setMessageBundle(String bundle);
/**
* Return the NavigationHandler object which is responsible for mapping from
* a logical (viewid, fromAction, outcome) to the URL of a view to be rendered.
*/
public abstract javax.faces.application.NavigationHandler getNavigationHandler();
public abstract void setNavigationHandler(javax.faces.application.NavigationHandler handler);
/**
* Get the object used by the VariableResolver to read and write named properties
* on java beans, Arrays, Lists and Maps. This object is used by the ValueBinding
* implementation, and during the process of configuring "managed bean" properties.
*/
public abstract javax.faces.el.PropertyResolver getPropertyResolver();
public abstract void setPropertyResolver(javax.faces.el.PropertyResolver resolver);
/**
* Get the object used to resolve expressions of form "#{...}".
*/
public abstract javax.faces.el.VariableResolver getVariableResolver();
public abstract void setVariableResolver(javax.faces.el.VariableResolver resolver);
public abstract javax.faces.application.ViewHandler getViewHandler();
public abstract void setViewHandler(javax.faces.application.ViewHandler handler);
public abstract javax.faces.application.StateManager getStateManager();
public abstract void setStateManager(javax.faces.application.StateManager manager);
/**
* Define a new mapping from a logical "component type" to an actual java class name.
* This controls what type is created when method createComponent of this class is
* called.
*
* Param componentClass must be the fully-qualified class name of some class
* extending the UIComponent class. The class must have a default constructor,
* as instances of it will be created using Class.newInstance.
*
* It is permitted to override a previously defined mapping, ie to call this
* method multiple times with the same componentType string. The createComponent
* method will simply use the last defined mapping.
*/
public abstract void addComponent(String componentType,
String componentClass);
/**
* Create a new UIComponent subclass, using the mappings defined by previous
* calls to the addComponent method of this class.
*
* @throws FacesException if there is no mapping defined for the specified
* componentType, or if an instance of the specified type could not be
* created for any reason.
*/
public abstract javax.faces.component.UIComponent createComponent(String componentType)
throws FacesException;
/**
* Create an object which has an associating "binding" expression tying the component
* to a user property.
*
* First the specified value-binding is evaluated; if it returns a non-null value then
* the component "already exists" and so the resulting value is simply returned.
*
* Otherwise a new UIComponent instance is created using the specified componentType,
* and the new object stored via the provided value-binding before being returned.
*/
public abstract javax.faces.component.UIComponent createComponent(
javax.faces.el.ValueBinding componentBinding,
javax.faces.context.FacesContext context,
String componentType)
throws FacesException;
public abstract Iterator getComponentTypes();
public abstract void addConverter(String converterId,
String converterClass);
public abstract void addConverter(Class targetClass,
String converterClass);
public abstract javax.faces.convert.Converter createConverter(String converterId);
public abstract javax.faces.convert.Converter createConverter(Class targetClass);
public abstract Iterator getConverterIds();
public abstract Iterator getConverterTypes();
/**
* Create an object which can be used to invoke an arbitrary method via an
* EL expression at a later time. This is similar to createValueBinding
* except that it can invoke an arbitrary method (with parameters) rather
* than just get/set a javabean property.
*
* This is used to invoke ActionListener method, and ValueChangeListener
* methods.
*/
public abstract javax.faces.el.MethodBinding createMethodBinding(
String ref, Class[] params)
throws ReferenceSyntaxException;
public abstract Iterator getSupportedLocales();
public abstract void setSupportedLocales(Collection locales);
public abstract void addValidator(String validatorId,
String validatorClass);
public abstract javax.faces.validator.Validator createValidator(String validatorId)
throws FacesException;
public abstract Iterator getValidatorIds();
/**
* Create an object which can be used to invoke an arbitrary method via an
* EL expression at a later time. This is similar to createValueBinding
* except that it can invoke an arbitrary method (with parameters) rather
* than just get/set a javabean property.
*
* This is used to invoke ActionListener method, and ValueChangeListener
* methods.
*/
public abstract javax.faces.el.ValueBinding createValueBinding(String ref)
throws ReferenceSyntaxException;
}