org.fujion.page

Class PageUtil

java.lang.Object

org.fujion.page.PageUtil

public class PageUtil
extends Object

Convenience methods for creating pages.

Method Summary

Modifier and Type	Method and Description
static List<BaseComponent>	createPage(PageDefinition def, BaseComponent parent) Creates a Fujion Server Page from a page definition.
static List<BaseComponent>	createPage(PageDefinition def, BaseComponent parent, Map<String,Object> args) Creates a Fujion Server Page from a page definition.
static List<BaseComponent>	createPage(String url, BaseComponent parent) Creates a Fujion Server Page given the URL of its page definition.
static List<BaseComponent>	createPage(String url, BaseComponent parent, Map<String,Object> args) Creates a Fujion Server Page given the URL of its page definition.
static List<BaseComponent>	createPageFromContent(String content, BaseComponent parent) Creates a Fujion Server Page directly from XML.
static List<BaseComponent>	createPageFromContent(String content, BaseComponent parent, Map<String,Object> args) Creates a Fujion Server Page directly from XML.
static PageDefinition	getPageDefinition(String url) Given the URL of its source, retrieves the page definition from the cache.
static boolean	inExecutionContext(Page page) Returns true if the current execution context belongs to the specified page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPageDefinition

public static PageDefinition getPageDefinition(String url)

Given the URL of its source, retrieves the page definition from the cache. If the page definition is not in the cache, it is retrieved, compiled, and placed in the cache.

Parameters:

url - The URL of the page definition.

Returns:

The page definition.

createPage

public static List<BaseComponent> createPage(String url,
                                             BaseComponent parent)

Creates a Fujion Server Page given the URL of its page definition.

Parameters:

url - URL of the page definition.

parent - Component the will become the parent of any top level components. May be null.

Returns:

A list of the top level components that were created.

createPage

public static List<BaseComponent> createPage(String url,
                                             BaseComponent parent,
                                             Map<String,Object> args)

Creates a Fujion Server Page given the URL of its page definition.

Parameters:

url - URL of the page definition.

parent - Component the will become the parent of any top level components. May be null.

args - A map of arguments that will be copied into the attribute maps of all top level components. This may be null.

Returns:

A list of the top level components that were created.

createPage

public static List<BaseComponent> createPage(PageDefinition def,
                                             BaseComponent parent)

Creates a Fujion Server Page from a page definition.

Parameters:

def - The page definition.

parent - Component the will become the parent of any top level components. May be null.

Returns:

A list of the top level components that were created.

createPage

public static List<BaseComponent> createPage(PageDefinition def,
                                             BaseComponent parent,
                                             Map<String,Object> args)

Creates a Fujion Server Page from a page definition.

Parameters:

def - The page definition.

parent - Component the will become the parent of any top level components. May be null.

args - A map of arguments that will be copied into the attribute maps of all top level components. This may be null.

Returns:

A list of the top level components that were created.

createPageFromContent

public static List<BaseComponent> createPageFromContent(String content,
                                                        BaseComponent parent)

Creates a Fujion Server Page directly from XML.

Parameters:

content - String containing FSP markup.

parent - Component the will become the parent of any top level components. May be null.

Returns:

A list of the top level components that were created.

createPageFromContent

public static List<BaseComponent> createPageFromContent(String content,
                                                        BaseComponent parent,
                                                        Map<String,Object> args)

Creates a Fujion Server Page directly from XML.

Parameters:

content - String containing FSP markup.

parent - Component the will become the parent of any top level components. May be null.

args - A map of arguments that will be copied into the attribute maps of all top level components. This may be null.

Returns:

A list of the top level components that were created.

inExecutionContext

public static boolean inExecutionContext(Page page)

Returns true if the current execution context belongs to the specified page.

Parameters:

page - Page instance.

Returns:

True if the current execution context belongs to the specified page.