| java.lang.Object
 org.apache.struts.tiles.TilesUtil
org.apache.struts.tiles.DefinitionsUtil
| Inner Class :static class ServletPropertiesMap extends HashMap | |
| Method Summary | |
| public static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, Map properties, String classname)
Create Definition factory.
If a factory class name is provided, a factory of this class is created. | | public static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, Map properties)
Create default Definition factory.
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
properties - Map of name/property used to initialize factory configuration object. | | public static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig)
Create Definition factory.
Create configuration object from servlet web.xml file, then create
ConfigurableDefinitionsFactory and initialized it with object.
Convenience method. | | public static DefinitionsFactory | createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist)
Create Definition factory.
Create configuration object from servlet web.xml file, then create
ConfigurableDefinitionsFactory and initialized it with object.
If checkIfExist is true, start by checking if factory already exist. | | public static ComponentDefinition | getActionDefinition(ServletRequest request)
Get Definition stored in jsp context by an action. | | public static DefinitionsFactory | getDefinitionsFactory(ServletContext servletContext)
Get definition factory from appropriate servlet context. | | public static void | populateDefinitionsFactoryConfig(DefinitionsFactoryConfig factoryConfig, ServletConfig servletConfig)
Populate Definition Factory Config from web.xml properties. | | protected static DefinitionsFactoryConfig | readFactoryConfig(ServletConfig servletConfig)
Create FactoryConfig and initialize it from web.xml. | | public static void | removeActionDefinition(ServletRequest request, ComponentDefinition definition)
Remove Definition stored in jsp context. | | public static void | setActionDefinition(ServletRequest request, ComponentDefinition definition)
Store definition in jsp context. |
| ACTION_DEFINITION | | final public static String ACTION_DEFINITION(Code) | | Constant name used to store definition in jsp context.
Used to pass definition from a Struts action to servlet forward.
|
| DEFINITIONS_CONFIG_USER_DEBUG_LEVEL | | final public static String DEFINITIONS_CONFIG_USER_DEBUG_LEVEL(Code) | | Name of init property carrying debug level.
|
| DEFINITIONS_FACTORY | | final public static String DEFINITIONS_FACTORY(Code) | | Constant name used to store factory in context.
|
| DEFINITIONS_FACTORY_CLASSNAME | | final public static String DEFINITIONS_FACTORY_CLASSNAME(Code) | | Name of init property carrying factory class name.
|
| NO_DEBUG | | final public static int NO_DEBUG(Code) | | User Debug level.
|
| log | | protected static Log log(Code) | | Commons Logging instance.
|
| userDebugLevel | | public static int userDebugLevel(Code) | | Global user defined debug level.
|
| createDefinitionsFactory | | public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map properties, String classname) throws DefinitionsFactoryException(Code) | | Create Definition factory.
If a factory class name is provided, a factory of this class is created. Otherwise,
default factory is created.
Parameters:
classname - Class name of the factory to create.
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
properties - Map of name/property used to initialize factory configuration object. newly created factory.
throws:
DefinitionsFactoryException - If an error occur while initializing factory |
| createDefinitionsFactory | | public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, Map properties) throws DefinitionsFactoryException(Code) | | Create default Definition factory.
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
properties - Map of name/property used to initialize factory configuration object. newly created factory of type ConfigurableDefinitionsFactory.
throws:
DefinitionsFactoryException - If an error occur while initializing factory |
| createDefinitionsFactory | | public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig) throws DefinitionsFactoryException(Code) | | Create Definition factory.
Create configuration object from servlet web.xml file, then create
ConfigurableDefinitionsFactory and initialized it with object.
Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
servletConfig - Servlet config containing parameters to be passed to factory configuration object. newly created factory of type ConfigurableDefinitionsFactory.
throws:
DefinitionsFactoryException - If an error occur while initializing factory |
| createDefinitionsFactory | | public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, ServletConfig servletConfig, boolean checkIfExist) throws DefinitionsFactoryException(Code) | | Create Definition factory.
Create configuration object from servlet web.xml file, then create
ConfigurableDefinitionsFactory and initialized it with object.
If checkIfExist is true, start by checking if factory already exist. If yes,
return it. If no, create a new one.
If checkIfExist is false, factory is always created.
Convenience method. Calls createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig)
Parameters:
servletContext - Servlet Context passed to newly created factory.
Parameters:
servletConfig - Servlet config containing parameters to be passed to factory configuration object.
Parameters:
checkIfExist - Check if factory already exist. If true and factory exist, return it.If true and factory doesn't exist, create it. If false, create it in all cases. newly created factory of type ConfigurableDefinitionsFactory.
throws:
DefinitionsFactoryException - If an error occur while initializing factory |
| getActionDefinition | | public static ComponentDefinition getActionDefinition(ServletRequest request)(Code) | | Get Definition stored in jsp context by an action.
ComponentDefinition or null if not found. |
| removeActionDefinition | | public static void removeActionDefinition(ServletRequest request, ComponentDefinition definition)(Code) | | Remove Definition stored in jsp context.
Mainly used by Struts to pass a definition defined in an Action to the forward.
|
| setActionDefinition | | public static void setActionDefinition(ServletRequest request, ComponentDefinition definition)(Code) | | Store definition in jsp context.
Mainly used by Struts to pass a definition defined in an Action to the forward.
|
| Methods inherited from org.apache.struts.tiles.TilesUtil | public static DefinitionsFactory createDefinitionsFactory(ServletContext servletContext, DefinitionsFactoryConfig factoryConfig) throws DefinitionsFactoryException(Code)(Java Doc)
public static void doForward(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) throws IOException, ServletException(Code)(Java Doc)
public static void doInclude(String uri, HttpServletRequest request, HttpServletResponse response, ServletContext servletContext) throws IOException, ServletException(Code)(Java Doc)
public static void doInclude(String uri, PageContext pageContext) throws IOException, ServletException(Code)(Java Doc)
public static void doInclude(String uri, PageContext pageContext, boolean flush) throws IOException, ServletException(Code)(Java Doc)
public static ComponentDefinition getDefinition(String definitionName, ServletRequest request, ServletContext servletContext) throws FactoryNotFoundException, DefinitionsFactoryException(Code)(Java Doc)
public static DefinitionsFactory getDefinitionsFactory(ServletRequest request, ServletContext servletContext)(Code)(Java Doc)
public static TilesUtilImpl getTilesUtil()(Code)(Java Doc)
static boolean isTilesUtilImplSet()(Code)(Java Doc)
public static void setTilesUtil(TilesUtilImpl tilesUtil)(Code)(Java Doc)
protected static void testReset()(Code)(Java Doc)
|
|
|