Package org.zkoss.zk.ui.metainfo

Class PageDefinition

java.lang.Object
org.zkoss.zk.ui.metainfo.PageDefinition
All Implemented Interfaces:
NodeInfo
public class PageDefinition extends 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:

  • Constructor Details

    • PageDefinition

      public PageDefinition(LanguageDefinition langdef, org.zkoss.util.resource.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, String id, String title, String style, org.zkoss.util.resource.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. See setId(java.lang.String).
      title - the title. See setTitle(java.lang.String).
      style - the CSS style. See setStyle(java.lang.String).

  • Method Details

    • getLanguageDefinition

      public LanguageDefinition getLanguageDefinition()
      Returns the language definition that this page is default to be.

    • getLocator

      public org.zkoss.util.resource.Locator getLocator()
      Returns the locator associated with this page definition.

    • getZScriptLanguage

      public 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(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 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(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 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(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 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(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 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(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 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(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 String getRequestPath()
      Returns the request path of this page definition, or "" if not available.

      It is the same as the servlet path (jakarta.servlet.http.HttpServletRequest's getServletPath), if ZK is running at a servlet container.

    • setRequestPath

      public void setRequestPath(String path)
      Sets the request path of this page definition.

    • imports

      public void imports(PageDefinition pgdef, 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(String clsptn) throws 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:
      ClassNotFoundException
      Since:
      6.0.0

    • getImportedClasses

      public List<String> getImportedClasses()
      Returns a readonly list of the imported class names.
      Since:
      6.0.0

    • getImportedClassResolver

      public org.zkoss.lang.ClassResolver getImportedClassResolver()
      Returns the class resolver represented by getImportedClasses().
      Since:
      6.0.0

    • addInitiatorInfo

      public void addInitiatorInfo(InitiatorInfo init)
      Adds a definition of Initiator.

    • doInit

      public List<Initiator> doInit(Page page)
      Returns a list of all Initiator and invokes its Initiator.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 of VariableResolver.

    • addFunctionMapperInfo

      public void addFunctionMapperInfo(FunctionMapperInfo mapper)
      Adds a definition of FunctionMapper.
      Since:
      3.5.0

    • addXelMethod

      public void addXelMethod(String prefix, String name, org.zkoss.xel.Function func)
      Adds a XEL method.
      Parameters:
      prefix - the prefix of the method name
      name - 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 Collection<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 of Date or String (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 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

      public 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:

    • addForwardInfo

      public void addForwardInfo(ForwardInfo forward)
      Adds a forward definition (ForwardInfo).

    • getForwardURI

      public String getForwardURI(Page page)
      Returns the URI to forward to, or null if not to forward. It evaluates the forward definition (added by addForwardInfo(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 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(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 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(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 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(String firstLine)
      Sets the first line to be generated to the output.

      Default: null (i.e., nothing generated)

      Since:
      3.0.0

    • getCacheable

      public 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(Boolean cacheable)
      Sets if the client can cache the rendered result.

      Default: null (use the device default).

      Since:
      3.0.0

    • getAutomaticTimeout

      public Boolean getAutomaticTimeout()
      Returns whether to automatically redirect to the timeout URI.
      Since:
      3.6.3
      See Also:

    • setAutomaticTimeout

      public void setAutomaticTimeout(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:

    • setRootAttribute

      public void setRootAttribute(String name, 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 String getRootAttributes(Page page)
      Converts the header definitions (added by setRootAttribute(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) against getComponentDefinitionMap()

    • getComponentDefinition

      public ComponentDefinition getComponentDefinition(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 from getLanguageDefinition()

    • getComponentDefinition

      public ComponentDefinition getComponentDefinition(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 from getLanguageDefinition()

    • addTaglib

      public void addTaglib(org.zkoss.xel.taglib.Taglib taglib)
      Adds a tag lib.

    • addExpressionImport

      public void addExpressionImport(String nm, Class<?> cls)
      Adds an imported class to the expression factory.
      Since:
      3.0.0

    • setExpressionFactoryClass

      public void setExpressionFactoryClass(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 implement ExpressionFactory. If null is specified, the class defined in Configuration.getExpressionFactoryClass()
      Throws:
      IllegalArgumentException - if expfcls does not implement ExpressionFactory
      Since:
      3.0.0

    • getExpressionFactoryClass

      public Class<? extends org.zkoss.xel.ExpressionFactory> getExpressionFactoryClass()
      Returns the implementation of the expression factory that is used by this page, or null if Configuration.getExpressionFactoryClass() is used.
      Since:
      3.0.0
      See Also:

    • 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 interface NodeInfo

    • getEvaluatorRef

      public EvaluatorRef getEvaluatorRef()
      Description copied from interface: NodeInfo
      Returns the evaluator reference.
      Specified by:
      getEvaluatorRef in interface NodeInfo

    • getTaglibMapper

      public org.zkoss.xel.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 Map<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>) and init(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) and Initiator.doInit(org.zkoss.zk.ui.Page, java.util.Map<java.lang.String, java.lang.Object>).

    • getParent

      public NodeInfo getParent()
      Returns the parent (always null).
      Specified by:
      getParent in interface NodeInfo

    • getPageDefinition

      public PageDefinition getPageDefinition()
      Returns the page definition (always this).
      Specified by:
      getPageDefinition in interface NodeInfo

    • appendChild

      public void appendChild(NodeInfo child)
      Description copied from interface: NodeInfo
      Append a child
      Specified by:
      appendChild in interface NodeInfo

    • removeChild

      public boolean removeChild(NodeInfo child)
      Description copied from interface: NodeInfo
      Removes a child.
      Specified by:
      removeChild in interface NodeInfo

    • getChildren

      public 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) and NodeInfo.removeChild(org.zkoss.zk.ui.metainfo.NodeInfo) instead.

      Specified by:
      getChildren in interface NodeInfo

    • toString

      public String toString()
      Overrides:
      toString in class Object