Class PageDefinition
- java.lang.Object
-
- org.zkoss.zk.ui.metainfo.PageDefinition
-
- All Implemented Interfaces:
NodeInfo
public class PageDefinition extends java.lang.Object implements NodeInfo
A page definition. It represents a ZUL page.Note: it is not thread-safe.
Note: it is not serializable.
- Author:
- tomyeh
- See Also:
ComponentDefinition
-
-
Constructor Summary
Constructors Constructor Description PageDefinition(LanguageDefinition langdef, java.lang.String id, java.lang.String title, java.lang.String style, Locator locator)
Constructor.PageDefinition(LanguageDefinition langdef, Locator locator)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addComponentDefinition(ComponentDefinition compdef)
Adds a component definition belonging to this page definition only.void
addExpressionImport(java.lang.String nm, java.lang.Class<?> cls)
Adds an imported class to the expression factory.void
addForwardInfo(ForwardInfo forward)
Adds a forward definition (ForwardInfo
).void
addFunctionMapperInfo(FunctionMapperInfo mapper)
Adds a definition ofFunctionMapper
.void
addHeaderInfo(HeaderInfo header)
Adds a header definition (HeaderInfo
).void
addHeaderInfo(HeaderInfo header, boolean before)
Adds a header definition (HeaderInfo
).void
addImportedClass(java.lang.String clsptn)
Adds an imported class Like Java, it is used to import a class or a package of classes, so that it simplifies the use of the apply attribute, the init directive and others.void
addInitiatorInfo(InitiatorInfo init)
Adds a definition ofInitiator
.void
addResponseHeaderInfo(ResponseHeaderInfo header)
Adds a response header.void
addTaglib(Taglib taglib)
Adds a tag lib.void
addTemplateInfo(TemplateInfo info)
Adds a template info The previous src of the same name will be replaced.void
addVariableResolverInfo(VariableResolverInfo resolver)
Adds a definition ofVariableResolver
.void
addXelMethod(java.lang.String prefix, java.lang.String name, Function func)
Adds a XEL method.void
appendChild(NodeInfo child)
Append a childjava.util.List<Initiator>
doInit(Page page)
Returns a list of allInitiator
and invokes itsInitiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>)
before returning.java.lang.String
getAfterHeadTags(Page page)
Returns the content that shall be generated inside the head element and after ZK's default tags (never null).java.lang.Boolean
getAutomaticTimeout()
Returns whether to automatically redirect to the timeout URI.java.lang.String
getBeforeHeadTags(Page page)
Returns the content that shall be generated inside the head element and before ZK's default tags (never null).java.lang.Boolean
getCacheable()
Returns if the client can cache the rendered result, or null to use the device default.java.util.List<NodeInfo>
getChildren()
Returns a readonly list of children.ComponentDefinition
getComponentDefinition(java.lang.Class cls, boolean recurse)
Returns the component definition of the specified class, or null if not found.ComponentDefinition
getComponentDefinition(java.lang.String name, boolean recurse)
Returns the component definition of the specified name, or null if not found.ComponentDefinitionMap
getComponentDefinitionMap()
Returns the map of component definition (never null).java.lang.String
getContentType(Page page)
Returns the content type (after evaluation), or null to use the device default.java.lang.String
getDocType(Page page)
Returns the doc type (<!Evaluator
getEvaluator()
Returns the evaluator.EvaluatorRef
getEvaluatorRef()
Returns the evaluator reference.java.lang.Class<? extends ExpressionFactory>
getExpressionFactoryClass()
Returns the implementation of the expression factory that is used by this page, or null ifConfiguration.getExpressionFactoryClass()
is used.java.lang.String
getFirstLine(Page page)
Returns the first line to be generated to the output (after evaluation), or null if nothing to generate.java.lang.String
getForwardURI(Page page)
Returns the URI to forward to, or null if not to forward.java.lang.String
getId()
Returns the identifier that will be assigned to pages created from this definition, or null if the identifier shall be generated automatically.java.util.List<java.lang.String>
getImportedClasses()
Returns a readonly list of the imported class names.ClassResolver
getImportedClassResolver()
Returns the class resolver represented bygetImportedClasses()
.LanguageDefinition
getLanguageDefinition()
Returns the language definition that this page is default to be.Locator
getLocator()
Returns the locator associated with this page definition.PageDefinition
getPageDefinition()
Returns the page definition (always this).NodeInfo
getParent()
Returns the parent (always null).java.lang.String
getRequestPath()
Returns the request path of this page definition, or "" if not available.java.util.Collection<java.lang.Object[]>
getResponseHeaders(Page page)
Returns a map of response headers (never null).java.lang.String
getRootAttributes(Page page)
Converts the header definitions (added bysetRootAttribute(java.lang.String, java.lang.String)
) to the attributes of the root element.java.lang.String
getStyle()
Returns the CSS style that will be assigned to pages created from this definition, or null if no style is assigned at the beginning.FunctionMapper
getTaglibMapper()
Returns the mapper representing the functions defined in taglib and xel-method.java.util.Map<java.lang.String,TemplateInfo>
getTemplatesInfo()
Gets templates info mapjava.lang.String
getTitle()
Returns the title that will be assigned to pages created from this definition, or null if no title is assigned at the beginning.java.lang.String
getViewport()
Returns the viewport that will be assigned to pages created from this definition, or "auto" if no viewport is assigned at the beginning.java.lang.String
getWidgetClass(Page page)
Returns the widget class of the given page, or null if the default is used.java.lang.String
getZScriptLanguage()
Returns the default scripting language which is assumed when a zscript element doesn't specify any language.void
imports(PageDefinition pgdef)
Imports the init directives and component definitions from the specified page definition.void
imports(PageDefinition pgdef, java.lang.String[] directives)
Imports the specified directives from the specified page definition.void
init(Page page, boolean evalHeaders)
Initializes a page after execution is activated.boolean
isComplete()
Returns if the page is a complete page.void
preInit(Page page)
Initializes the context for the given page before rendering this page definition.boolean
removeChild(NodeInfo child)
Removes a child.void
setAutomaticTimeout(java.lang.Boolean autoTimeout)
Sets whether to automatically redirect to the timeout URI.void
setCacheable(java.lang.Boolean cacheable)
Sets if the client can cache the rendered result.void
setComplete(boolean complete)
Sets if the page is a complete page.void
setContentType(java.lang.String contentType)
Sets the content type.void
setDocType(java.lang.String docType)
Sets the doc type (<!void
setExpressionFactoryClass(java.lang.Class<?> expfcls)
Sets the implementation of the expression factory that shall be used by this page.void
setFirstLine(java.lang.String firstLine)
Sets the first line to be generated to the output.void
setId(java.lang.String id)
Sets the identifier that will be assigned to pages created from this definition.void
setRequestPath(java.lang.String path)
Sets the request path of this page definition.void
setRootAttribute(java.lang.String name, java.lang.String value)
Adds a root attribute.void
setStyle(java.lang.String style)
Sets the CSS style that will be assigned to pages created from this definition, or null if no style is assigned at the beginning.void
setTitle(java.lang.String title)
Sets the title that will be assigned to pages created from this definition, or null if no title is assigned at the beginning.void
setViewport(java.lang.String viewport)
Sets the viewport that will be assigned to pages created from this definition, or "auto" if no viewport is assigned at the beginning.void
setWidgetClass(java.lang.String wgtcls)
Sets the widget class of the page.void
setZScriptLanguage(java.lang.String zslang)
Sets the default scripting language which is assumed when a zscript element doesn't specify any language.java.lang.String
toString()
-
-
-
Constructor Detail
-
PageDefinition
public PageDefinition(LanguageDefinition langdef, Locator locator)
Constructor.- Parameters:
langdef
- the default language which is used if no namespace is specified. Note: a page might have components from different languages.
-
PageDefinition
public PageDefinition(LanguageDefinition langdef, java.lang.String id, java.lang.String title, java.lang.String style, Locator locator)
Constructor.- Parameters:
langdef
- the default language which is used if no namespace is specified. Note: a page might have components from different languages.id
- the identifier. SeesetId(java.lang.String)
.title
- the title. SeesetTitle(java.lang.String)
.style
- the CSS style. SeesetStyle(java.lang.String)
.
-
-
Method Detail
-
getLanguageDefinition
public LanguageDefinition getLanguageDefinition()
Returns the language definition that this page is default to be.
-
getLocator
public Locator getLocator()
Returns the locator associated with this page definition.
-
getZScriptLanguage
public java.lang.String getZScriptLanguage()
Returns the default scripting language which is assumed when a zscript element doesn't specify any language.Default: Java.
-
setZScriptLanguage
public void setZScriptLanguage(java.lang.String zslang)
Sets the default scripting language which is assumed when a zscript element doesn't specify any language.- Parameters:
zslang
- the default scripting language.
-
getId
public java.lang.String getId()
Returns the identifier that will be assigned to pages created from this definition, or null if the identifier shall be generated automatically.Note: the returned value might contain EL expressions.
-
setId
public void setId(java.lang.String id)
Sets the identifier that will be assigned to pages created from this definition.- Parameters:
id
- the identifier. It might contain EL expressions. If null or empty (null is assumed), page's ID is generated automatically. If not empty, ID (after evaluated) must be unique in the same request.
-
getTitle
public java.lang.String getTitle()
Returns the title that will be assigned to pages created from this definition, or null if no title is assigned at the beginning.Note: the returned value might contain EL expressions.
-
setTitle
public void setTitle(java.lang.String title)
Sets the title that will be assigned to pages created from this definition, or null if no title is assigned at the beginning.- Parameters:
title
- the title. If empty, null is assumed.
-
getStyle
public java.lang.String getStyle()
Returns the CSS style that will be assigned to pages created from this definition, or null if no style is assigned at the beginning.Note: the returned value might contain EL expressions.
-
setStyle
public void setStyle(java.lang.String style)
Sets the CSS style that will be assigned to pages created from this definition, or null if no style is assigned at the beginning.- Parameters:
style
- the CSS style. If empty, null is assumed.
-
getViewport
public java.lang.String getViewport()
Returns the viewport that will be assigned to pages created from this definition, or "auto" if no viewport is assigned at the beginning.Note: the returned value might contain EL expressions.
- Since:
- 6.5.0
-
setViewport
public void setViewport(java.lang.String viewport)
Sets the viewport that will be assigned to pages created from this definition, or "auto" if no viewport is assigned at the beginning.- Parameters:
viewport
- the viewport setting. If empty, "auto" is assumed.- Since:
- 6.5.0
-
getWidgetClass
public java.lang.String getWidgetClass(Page page)
Returns the widget class of the given page, or null if the default is used.- Since:
- 5.0.5
-
setWidgetClass
public void setWidgetClass(java.lang.String wgtcls)
Sets the widget class of the page.- Parameters:
wgtcls
- the widget class. It may contain EL expressions. If null or empty, the default widget class is assumed.- Since:
- 5.0.5
-
getRequestPath
public java.lang.String getRequestPath()
Returns the request path of this page definition, or "" if not available.It is the same as the servlet path (javax.servlet.http.HttpServletRequest's getServletPath), if ZK is running at a servlet container.
-
setRequestPath
public void setRequestPath(java.lang.String path)
Sets the request path of this page definition.
-
imports
public void imports(PageDefinition pgdef, java.lang.String[] directives)
Imports the specified directives from the specified page definition.- Parameters:
pgdef
- the page definition to import from.directives
- an array of the directive names to import. If null, {"init", "component"} is assumed, i.e., only the init directives and component definitions are imported.
Importable directives include "component", "init", "meta", "taglib", "variable-resolver", and "xel-method". If "*", all of them are imported. Note: "meta" implies "link".- Since:
- 3.0.2
-
imports
public void imports(PageDefinition pgdef)
Imports the init directives and component definitions from the specified page definition.It is the same as imports(pgdef, null).
- Since:
- #imports(PageDefinition, String[])
-
addImportedClass
public void addImportedClass(java.lang.String clsptn) throws java.lang.ClassNotFoundException
Adds an imported class Like Java, it is used to import a class or a package of classes, so that it simplifies the use of the apply attribute, the init directive and others.- Parameters:
clsptn
- the class's fully-qualified name, e.g.,com.foo.FooComposer
, a wildcard representing all classes of the give package, e.g.,com.foo.*
.- Throws:
java.lang.ClassNotFoundException
- Since:
- 6.0.0
-
getImportedClasses
public java.util.List<java.lang.String> getImportedClasses()
Returns a readonly list of the imported class names.- Since:
- 6.0.0
-
getImportedClassResolver
public ClassResolver getImportedClassResolver()
Returns the class resolver represented bygetImportedClasses()
.- Since:
- 6.0.0
-
addInitiatorInfo
public void addInitiatorInfo(InitiatorInfo init)
Adds a definition ofInitiator
.
-
doInit
public java.util.List<Initiator> doInit(Page page)
Returns a list of allInitiator
and invokes itsInitiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>)
before returning. It never returns null.
-
addVariableResolverInfo
public void addVariableResolverInfo(VariableResolverInfo resolver)
Adds a definition ofVariableResolver
.
-
addFunctionMapperInfo
public void addFunctionMapperInfo(FunctionMapperInfo mapper)
Adds a definition ofFunctionMapper
.- Since:
- 3.5.0
-
addXelMethod
public void addXelMethod(java.lang.String prefix, java.lang.String name, Function func)
Adds a XEL method.- Parameters:
prefix
- the prefix of the method namename
- the method name. The final name is "prefix:name"func
- the function.- Since:
- 3.0.0
-
addResponseHeaderInfo
public void addResponseHeaderInfo(ResponseHeaderInfo header)
Adds a response header.- Since:
- 5.0.2
-
getResponseHeaders
public java.util.Collection<java.lang.Object[]> getResponseHeaders(Page page)
Returns a map of response headers (never null). The value of each entry is a two-element object array. The first element of the array is the value which is an instance ofDate
orString
(and never null). The second element indicates whether to add (rather than set) header. It is an instance of Boolean (and never null).
-
addHeaderInfo
public void addHeaderInfo(HeaderInfo header, boolean before)
Adds a header definition (HeaderInfo
).- Parameters:
before
- whether to place the header before ZK's CSS/JS headers. If false, it is placed after ZK's CSS/JS headers.- Since:
- 3.6.1
-
addHeaderInfo
public void addHeaderInfo(HeaderInfo header)
Adds a header definition (HeaderInfo
). It places the meta headers before ZK's CSS/JS headers, and others after ZK's CSS/JS headers.
-
getBeforeHeadTags
public java.lang.String getBeforeHeadTags(Page page)
Returns the content that shall be generated inside the head element and before ZK's default tags (never null). For example, it might consist of <meta> and <link>.Since it is generated before ZK's default tags (such as CSS and JS), it cannot override ZK's default behaviors.
- Since:
- 5.0.5
- See Also:
getAfterHeadTags(org.zkoss.zk.ui.Page)
-
getAfterHeadTags
public java.lang.String getAfterHeadTags(Page page)
Returns the content that shall be generated inside the head element and after ZK's default tags (never null). For example, it might consist of <meta> and <link>.Since it is generated after ZK's default tags (such as CSS and JS), it could override ZK's default behaviors.
- Since:
- 5.0.5
- See Also:
getBeforeHeadTags(org.zkoss.zk.ui.Page)
-
addForwardInfo
public void addForwardInfo(ForwardInfo forward)
Adds a forward definition (ForwardInfo
).
-
getForwardURI
public java.lang.String getForwardURI(Page page)
Returns the URI to forward to, or null if not to forward. It evaluates the forward definition (added byaddForwardInfo(org.zkoss.zk.ui.metainfo.ForwardInfo)
) one-by-one, if any, to see whether to forward. Returns null if no forward definition, or no forward definition's condition is satisfied.
-
getContentType
public java.lang.String getContentType(Page page)
Returns the content type (after evaluation), or null to use the device default.- Parameters:
page
- the page used to evaluate EL expressions, if any- Since:
- 3.0.0
-
setContentType
public void setContentType(java.lang.String contentType)
Sets the content type.Default: null (use the device default).
- Parameters:
contentType
- the content type. It may contain EL expressions.- Since:
- 3.0.0
-
getDocType
public java.lang.String getDocType(Page page)
Returns the doc type (<!DOCTYPE>) (after evaluation), or null to use the device default.- Parameters:
page
- the page used to evaluate EL expressions, if any- Since:
- 3.0.0
-
setDocType
public void setDocType(java.lang.String docType)
Sets the doc type (<!DOCTYPE>).Default: null (use the device default).
- Parameters:
docType
- the doc type. It may contain EL expressions. If null, it means device's default will be used. If empty, it means no doc type will be generated.- Since:
- 3.0.0
-
getFirstLine
public java.lang.String getFirstLine(Page page)
Returns the first line to be generated to the output (after evaluation), or null if nothing to generate.For XML devices, it is usually the xml processing instruction:
<?xml version="1.0" encoding="UTF-8"?>
- Parameters:
page
- the page used to evaluate EL expressions, if any- Since:
- 3.0.0
-
setFirstLine
public void setFirstLine(java.lang.String firstLine)
Sets the first line to be generated to the output.Default: null (i.e., nothing generated)
- Since:
- 3.0.0
-
getCacheable
public java.lang.Boolean getCacheable()
Returns if the client can cache the rendered result, or null to use the device default.- Since:
- 3.0.0
-
setCacheable
public void setCacheable(java.lang.Boolean cacheable)
Sets if the client can cache the rendered result.Default: null (use the device default).
- Since:
- 3.0.0
-
getAutomaticTimeout
public java.lang.Boolean getAutomaticTimeout()
Returns whether to automatically redirect to the timeout URI.- Since:
- 3.6.3
- See Also:
setAutomaticTimeout(java.lang.Boolean)
-
setAutomaticTimeout
public void setAutomaticTimeout(java.lang.Boolean autoTimeout)
Sets whether to automatically redirect to the timeout URI.Default: null (use the device default). Refer to
Configuration.setAutomaticTimeout(java.lang.String, boolean)
for details.- Since:
- 3.6.3
-
isComplete
public boolean isComplete()
Returns if the page is a complete page. By complete we mean the page has everything that the client expects. For example, for HTML output, the page will generate the HTML, HEAD and BODY tags.By default (false), we assume a page is complete if and only if it is not included by other page.
If you have a page that has a complete HTML page and it is included by other page, you have to specify the complete flag to be true.
- Since:
- 3.0.4
-
setComplete
public void setComplete(boolean complete)
Sets if the page is a complete page.Default: false. It means a page is complete if and only if it is not included by other page.
- Parameters:
complete
- whether the page is complete. If true, this page is assumed to be complete no matter it is included or not. If false, this page is assumed to be complete if it is not included by other page.- Since:
- 3.0.4
- See Also:
isComplete()
-
setRootAttribute
public void setRootAttribute(java.lang.String name, java.lang.String value)
Adds a root attribute. The previous attribute of the same name will be replaced.- Parameters:
value
- the value. If null, the attribute is removed. It can be an EL expression.- Since:
- 3.0.0
-
getRootAttributes
public java.lang.String getRootAttributes(Page page)
Converts the header definitions (added bysetRootAttribute(java.lang.String, java.lang.String)
) to the attributes of the root element. For HTML, the root element is the HTML element.- Since:
- 3.0.0
-
getComponentDefinitionMap
public ComponentDefinitionMap getComponentDefinitionMap()
Returns the map of component definition (never null).
-
addComponentDefinition
public void addComponentDefinition(ComponentDefinition compdef)
Adds a component definition belonging to this page definition only.It is the same as calling
ComponentDefinitionMap.add(org.zkoss.zk.ui.metainfo.ComponentDefinition)
againstgetComponentDefinitionMap()
-
getComponentDefinition
public ComponentDefinition getComponentDefinition(java.lang.String name, boolean recurse)
Returns the component definition of the specified name, or null if not found.Note: unlike
LanguageDefinition.getComponentDefinition(java.lang.String)
, this method doesn't throw ComponentNotFoundException if not found. It just returns null.- Parameters:
recurse
- whether to look up the component fromgetLanguageDefinition()
-
getComponentDefinition
public ComponentDefinition getComponentDefinition(java.lang.Class cls, boolean recurse)
Returns the component definition of the specified class, or null if not found.Note: unlike
LanguageDefinition.getComponentDefinition(java.lang.String)
, this method doesn't throw ComponentNotFoundException if not found. It just returns null.- Parameters:
recurse
- whether to look up the component fromgetLanguageDefinition()
-
addTaglib
public void addTaglib(Taglib taglib)
Adds a tag lib.
-
addExpressionImport
public void addExpressionImport(java.lang.String nm, java.lang.Class<?> cls)
Adds an imported class to the expression factory.- Since:
- 3.0.0
-
setExpressionFactoryClass
public void setExpressionFactoryClass(java.lang.Class<?> expfcls)
Sets the implementation of the expression factory that shall be used by this page.Default: null (use the default).
- Parameters:
expfcls
- the implementation class, or null to use the default. Note: expfcls must implementExpressionFactory
. If null is specified, the class defined inConfiguration.getExpressionFactoryClass()
- Throws:
java.lang.IllegalArgumentException
- if expfcls does not implement ExpressionFactory- Since:
- 3.0.0
-
getExpressionFactoryClass
public java.lang.Class<? extends ExpressionFactory> getExpressionFactoryClass()
Returns the implementation of the expression factory that is used by this page, or null ifConfiguration.getExpressionFactoryClass()
is used.- Since:
- 3.0.0
- See Also:
setExpressionFactoryClass(java.lang.Class<?>)
-
getEvaluator
public Evaluator getEvaluator()
Description copied from interface:NodeInfo
Returns the evaluator.All nodes in the same ZUML tree has the same evaluator reference (inherited from the root node,
getEvaluatorRef()
).- Specified by:
getEvaluator
in interfaceNodeInfo
-
getEvaluatorRef
public EvaluatorRef getEvaluatorRef()
Description copied from interface:NodeInfo
Returns the evaluator reference.- Specified by:
getEvaluatorRef
in interfaceNodeInfo
-
getTaglibMapper
public FunctionMapper getTaglibMapper()
Returns the mapper representing the functions defined in taglib and xel-method.Note: it doesn't include the function mapper defined added by
addFunctionMapperInfo(org.zkoss.zk.ui.metainfo.FunctionMapperInfo)
.- Since:
- 3.5.0
-
addTemplateInfo
public void addTemplateInfo(TemplateInfo info)
Adds a template info The previous src of the same name will be replaced.- Parameters:
info
- the src. If null, the attribute is removed.- Since:
- 8.0.0
-
getTemplatesInfo
public java.util.Map<java.lang.String,TemplateInfo> getTemplatesInfo()
Gets templates info map- Since:
- 8.0.0
-
preInit
public void preInit(Page page)
Initializes the context for the given page before rendering this page definition.It is called before
Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>)
andinit(org.zkoss.zk.ui.Page, boolean)
.- Parameters:
page
- the page to initialize the context. It cannot be null.
-
init
public void init(Page page, boolean evalHeaders)
Initializes a page after execution is activated. It setup the identifier and title, and adds it to desktop.It is called after
preInit(org.zkoss.zk.ui.Page)
andInitiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>)
.
-
getParent
public NodeInfo getParent()
Returns the parent (always null).
-
getPageDefinition
public PageDefinition getPageDefinition()
Returns the page definition (always this).- Specified by:
getPageDefinition
in interfaceNodeInfo
-
appendChild
public void appendChild(NodeInfo child)
Description copied from interface:NodeInfo
Append a child- Specified by:
appendChild
in interfaceNodeInfo
-
removeChild
public boolean removeChild(NodeInfo child)
Description copied from interface:NodeInfo
Removes a child.- Specified by:
removeChild
in interfaceNodeInfo
-
getChildren
public java.util.List<NodeInfo> getChildren()
Description copied from interface:NodeInfo
Returns a readonly list of children.Note: the returned list is readonly. To modify, please use
NodeInfo.appendChild(org.zkoss.zk.ui.metainfo.NodeInfo)
andNodeInfo.removeChild(org.zkoss.zk.ui.metainfo.NodeInfo)
instead.- Specified by:
getChildren
in interfaceNodeInfo
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-