com.cc.framework.taglib.template
Class PageDef

java.lang.Object
  com.cc.framework.taglib.template.PageDef

public class PageDef

extends java.lang.Object

Page Definition

Since:

1.0

Version:

$Revision: 1.3 $

Author:

Harald Schulz

Field Summary

private java.lang.String	base The Base Directory for this page
private java.lang.String	localeName Locale Name
private java.util.Map	params Parameters
private java.lang.String	template The template

Constructor Summary

PageDef(java.lang.String base, java.lang.String template, java.lang.String localeName)
Constructor

Method Summary

void	addPageParameter(java.lang.String name, PageParameter param) Adds a named page parameter
java.lang.String	getBase()
java.util.Locale	getLocale(javax.servlet.jsp.PageContext pageContext) Returns the locale to use
java.lang.String	getLocaleName()
PageParameter	getPageParameter(java.lang.String name) Retrieves a named page parameter
java.util.Set	getParameterNames() Returns the parameter names in this page.
java.lang.String	getResourcePath()
java.lang.String	getTemplate()
int	size() Returns the number of page parameters in this page.

Methods inherited from class java.lang.Object

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

Field Detail

base

private java.lang.String base

The Base Directory for this page

template

private java.lang.String template

The template

localeName

private java.lang.String localeName

Locale Name

params

private java.util.Map params

Parameters

Constructor Detail

PageDef

public PageDef(java.lang.String base,
               java.lang.String template,
               java.lang.String localeName)

Constructor

Parameters:

base - Base directory for all contained parameters

template - The template page

localeName - Locale Name

Method Detail

getBase

public java.lang.String getBase()

Returns:

Returns the base directory.

getTemplate

public java.lang.String getTemplate()

Returns:

Returns the template.

getLocaleName

public java.lang.String getLocaleName()

Returns:

Returns the localeName.

getLocale

public java.util.Locale getLocale(javax.servlet.jsp.PageContext pageContext)

Returns the locale to use

Parameters:

pageContext - Page Context

Returns:

Locale or null

getResourcePath

public java.lang.String getResourcePath()

Returns:

The path of the Template JSP Page

addPageParameter

public void addPageParameter(java.lang.String name,
                             PageParameter param)

Adds a named page parameter

Parameters:

name - Parameter name

param - The Parameter Definition

getPageParameter

public PageParameter getPageParameter(java.lang.String name)

Retrieves a named page parameter

Parameters:

name - Parameter name

Returns:

Parameter or null

size

public int size()

Returns the number of page parameters in this page.

Returns:

the number of page parameters in this page.

getParameterNames

public java.util.Set getParameterNames()

Returns the parameter names in this page.

Returns:

the parameter names.