org.jboss.seam.navigation
Class Page

java.lang.Object
  org.jboss.seam.navigation.Page

public final class Page
extends java.lang.Object

Metadata about page actions, page parameters, action navigation, resource bundle, etc, for a particular JSF view id.

Field Summary

static java.lang.String

RFC_1123_DATE

Constructor Summary

Page(java.lang.String viewId)

Method Summary

void	addEventType(java.lang.String eventType)
void	addRewritePattern(java.lang.String value)
java.util.List<Action>	getActions()
java.lang.Integer	getConcurrentRequestTimeout()
ConversationControl	getConversationControl()
ConversationIdParameter	getConversationIdParameter()
Navigation	getDefaultNavigation()
java.lang.String	getDescription()
java.util.List<java.lang.String>	getEventTypes()
java.util.List<Header>	getHeaders()
java.util.List<Input>	getInputs()
java.util.Map<java.lang.String,Navigation>	getNavigations()
Expressions.ValueExpression<java.lang.String>	getNoConversationViewId()
java.util.List<Param>	getParameters()
ProcessControl	getProcessControl()
java.util.ResourceBundle	getResourceBundle()
java.lang.String	getResourceBundleName()
java.lang.String	getRestriction()
java.util.List<Pattern>	getRewritePatterns()
java.lang.String	getScheme()
TaskControl	getTaskControl()
java.lang.Integer	getTimeout()
java.lang.String	getViewId()
boolean	hasDescription()
boolean	isConversationRequired()
boolean	isLoginRequired()
boolean	isRestricted()
boolean	isSwitchEnabled()
boolean	isValidateModel() Indicates whether the model validator (Hibernate Validator) should be registered on the page parameters by default.
void	postRestore(javax.faces.context.FacesContext facesContext) Check the restore permission.
boolean	preRender(javax.faces.context.FacesContext facesContext) Call page actions, in order they appear in XML, and handle conversation begin/end.
java.lang.String	renderDescription()
void	setConcurrentRequestTimeout(java.lang.Integer concurrentRequestTimeout)
void	setConversationIdParameter(ConversationIdParameter param)
void	setConversationRequired(boolean conversationRequired)
void	setDefaultNavigation(Navigation defaultActionOutcomeMapping)
void	setDescription(java.lang.String description)
void	setExpires(java.lang.Integer expires)
void	setLoginRequired(boolean loginRequired)
void	setNoConversationViewId(Expressions.ValueExpression<java.lang.String> noConversationViewId)
void	setResourceBundleName(java.lang.String resourceBundleName)
void	setRestricted(boolean restricted)
void	setRestriction(java.lang.String restriction)
void	setScheme(java.lang.String scheme)
void	setSwitchEnabled(boolean switchEnabled)
void	setTimeout(java.lang.Integer timeout)
void	setValidateModel(boolean validateModel)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RFC_1123_DATE

public static final java.lang.String RFC_1123_DATE

See Also:

Constant Field Values

Constructor Detail

Page

public Page(java.lang.String viewId)

Method Detail

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getViewId

public java.lang.String getViewId()

renderDescription

public java.lang.String renderDescription()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setTimeout

public void setTimeout(java.lang.Integer timeout)

getTimeout

public java.lang.Integer getTimeout()

setConcurrentRequestTimeout

public void setConcurrentRequestTimeout(java.lang.Integer concurrentRequestTimeout)

getConcurrentRequestTimeout

public java.lang.Integer getConcurrentRequestTimeout()

setNoConversationViewId

public void setNoConversationViewId(Expressions.ValueExpression<java.lang.String> noConversationViewId)

getNoConversationViewId

public Expressions.ValueExpression<java.lang.String> getNoConversationViewId()

setResourceBundleName

public void setResourceBundleName(java.lang.String resourceBundleName)

getResourceBundleName

public java.lang.String getResourceBundleName()

setSwitchEnabled

public void setSwitchEnabled(boolean switchEnabled)

isSwitchEnabled

public boolean isSwitchEnabled()

setValidateModel

public void setValidateModel(boolean validateModel)

isValidateModel

public boolean isValidateModel()

Indicates whether the model validator (Hibernate Validator) should be registered on the page parameters by default. The default is to add the model validator. This setting can be overridden per page parameter. If parameters are registered on the page programatically, this setting should be honored as the default.

getParameters

public java.util.List<Param> getParameters()

getNavigations

public java.util.Map<java.lang.String,Navigation> getNavigations()

hasDescription

public boolean hasDescription()

isConversationRequired

public boolean isConversationRequired()

setConversationRequired

public void setConversationRequired(boolean conversationRequired)

getDefaultNavigation

public Navigation getDefaultNavigation()

setDefaultNavigation

public void setDefaultNavigation(Navigation defaultActionOutcomeMapping)

getConversationControl

public ConversationControl getConversationControl()

getTaskControl

public TaskControl getTaskControl()

getProcessControl

public ProcessControl getProcessControl()

getActions

public java.util.List<Action> getActions()

postRestore

public void postRestore(javax.faces.context.FacesContext facesContext)

Check the restore permission.

preRender

public boolean preRender(javax.faces.context.FacesContext facesContext)

Call page actions, in order they appear in XML, and handle conversation begin/end. Also check the render permission.

getInputs

public java.util.List<Input> getInputs()

isRestricted

public boolean isRestricted()

setRestricted

public void setRestricted(boolean restricted)

getRestriction

public java.lang.String getRestriction()

setRestriction

public void setRestriction(java.lang.String restriction)

isLoginRequired

public boolean isLoginRequired()

setLoginRequired

public void setLoginRequired(boolean loginRequired)

getScheme

public java.lang.String getScheme()

setScheme

public void setScheme(java.lang.String scheme)

getConversationIdParameter

public ConversationIdParameter getConversationIdParameter()

setConversationIdParameter

public void setConversationIdParameter(ConversationIdParameter param)

getEventTypes

public java.util.List<java.lang.String> getEventTypes()

addEventType

public void addEventType(java.lang.String eventType)

getRewritePatterns

public java.util.List<Pattern> getRewritePatterns()

addRewritePattern

public void addRewritePattern(java.lang.String value)

getHeaders

public java.util.List<Header> getHeaders()

setExpires

public void setExpires(java.lang.Integer expires)