## Uses of Class
org.zkoss.zk.ui.metainfo.PageDefinition

- Packages that use PageDefinition
  Package | Description
  --- | ---
  org.zkoss.bind.impl |
  org.zkoss.stateless.ui.util |
  org.zkoss.zk.ui |
  org.zkoss.zk.ui.http |
  org.zkoss.zk.ui.impl |
  org.zkoss.zk.ui.metainfo |
  org.zkoss.zk.ui.metainfo.impl |
  org.zkoss.zk.ui.sys |
  org.zkoss.zk.xel |

- - ### Uses of PageDefinition in org.zkoss.bind.impl

    Methods in org.zkoss.bind.impl with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | ClientBinderCommandParser.`parse​(Attribute attr, ComponentInfo compInfo, PageDefinition pgdef)` |

  - ### Uses of PageDefinition in org.zkoss.stateless.ui.util

    Methods in org.zkoss.stateless.ui.util with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `static <T extends IComponent> java.util.List<T>` | Immutables.`createComponents​(PageDefinition pagedef, java.util.Map<?,​?> arg)` | Creates `IComponent`s from `Component`s that don't belong to any page from the specified page definition.

    Constructors in org.zkoss.stateless.ui.util with parameters of type PageDefinition
    Constructor | Description
    --- | ---
    `VolatileIPage​(PageDefinition pgdef)` |

  - ### Uses of PageDefinition in org.zkoss.zk.ui

    Methods in org.zkoss.zk.ui that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | Execution.`getPageDefinition​(java.lang.String uri)` | Returns the page definition from the page file specified by an URI.
    `static PageDefinition` | Executions.`getPageDefinition​(WebApp wapp, java.lang.String uri)` | Returns the page definition from the page file specified by an URI.
    `PageDefinition` | Execution.`getPageDefinitionDirectly​(java.io.Reader reader, java.lang.String extension)` | Reads the raw content from a reader and converts it into a page definition.
    `PageDefinition` | Execution.`getPageDefinitionDirectly​(java.lang.String content, java.lang.String extension)` | Converts the specified page content to a page definition.
    `PageDefinition` | Execution.`getPageDefinitionDirectly​(Document content, java.lang.String extension)` | Converts the specified page content, in DOM, to a page definition.
    `PageDefinition` | Executions.`getPageDefinitionDirectly​(WebApp wapp, java.io.Reader reader, java.lang.String extension)` | Reads the raw content from a reader and converts it into a page definition.
    `PageDefinition` | Executions.`getPageDefinitionDirectly​(WebApp wapp, java.lang.String content, java.lang.String extension)` | Converts the specified page content to a page definition.
    `PageDefinition` | Executions.`getPageDefinitionDirectly​(WebApp wapp, Document content, java.lang.String extension)` | Converts the specified page content, in DOM, to a page definition.

    Methods in org.zkoss.zk.ui with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `Component[]` | Execution.`createComponents​(PageDefinition pagedef, java.util.Map<?,​?> arg)` | Creates components that don't belong to any page from the specified page definition.
    `Component` | Execution.`createComponents​(PageDefinition pagedef, Component parent, java.util.Map<?,​?> arg)` | Creates components from the specified page definition.
    `Component` | Execution.`createComponents​(PageDefinition pagedef, Component parent, Component insertBefore, VariableResolver resolver)` | Creates components from the specified page definition with a custom variable resolver and inserts before a particular component.
    `static Component` | Executions.`createComponents​(PageDefinition pagedef, Component parent, java.util.Map<?,​?> arg)` | Creates components based on the specified page definition.
    `static Component[]` | Executions.`createComponents​(WebApp wapp, PageDefinition pagedef, java.util.Map<?,​?> arg)` | Creates components that don't belong to any page from the specified page definition.

  - ### Uses of PageDefinition in org.zkoss.zk.ui.http

    Methods in org.zkoss.zk.ui.http that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | ExecutionImpl.`getPageDefinition​(java.lang.String uri)` |
    `PageDefinition` | ExecutionImpl.`getPageDefinitionDirectly​(java.io.Reader reader, java.lang.String ext)` |
    `PageDefinition` | ExecutionImpl.`getPageDefinitionDirectly​(java.lang.String content, java.lang.String ext)` |
    `PageDefinition` | ExecutionImpl.`getPageDefinitionDirectly​(Document content, java.lang.String ext)` |

    Methods in org.zkoss.zk.ui.http with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Page` | WebManager.`newPage​(UiFactory uf, RequestInfo ri, PageDefinition pagedef, javax.servlet.ServletResponse response, java.lang.String path)` | Creates a page.

  - ### Uses of PageDefinition in org.zkoss.zk.ui.impl

    Methods in org.zkoss.zk.ui.impl that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | AbstractExecution.`getCurrentPageDefinition()` |
    `PageDefinition` | AbstractUiFactory.`getPageDefinition​(RequestInfo ri, java.lang.String path)` | Returns the page definition of the specified path, or null if not found.
    `PageDefinition` | AbstractUiFactory.`getPageDefinitionDirectly​(RequestInfo ri, java.io.Reader reader, java.lang.String extension)` |
    `PageDefinition` | AbstractUiFactory.`getPageDefinitionDirectly​(RequestInfo ri, java.lang.String content, java.lang.String extension)` | Returns the page definition of the specified content; never null.
    `PageDefinition` | AbstractUiFactory.`getPageDefinitionDirectly​(RequestInfo ri, Document content, java.lang.String extension)` |

    Methods in org.zkoss.zk.ui.impl with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `Component[]` | AbstractExecution.`createComponents​(PageDefinition pagedef, java.util.Map<?,​?> arg)` |
    `Component` | AbstractExecution.`createComponents​(PageDefinition pagedef, Component parent, java.util.Map<?,​?> arg)` |
    `Component` | AbstractExecution.`createComponents​(PageDefinition pagedef, Component parent, Component insertBefore, VariableResolver resolver)` |
    `Component[]` | UiEngineImpl.`createComponents​(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, VariableResolver resolver, java.util.Map<?,​?> arg)` |
    `void` | UiEngineImpl.`execNewPage​(Execution exec, PageDefinition pagedef, Page page, java.io.Writer out)` |
    `Page` | AbstractUiFactory.`newPage​(RequestInfo ri, PageDefinition pagedef, java.lang.String path)` |
    `void` | AbstractExecution.`setCurrentPageDefinition​(PageDefinition pgdef)` |

    Constructors in org.zkoss.zk.ui.impl with parameters of type PageDefinition
    Constructor | Description
    --- | ---
    `PageImpl​(PageDefinition pgdef)` | Constructs a page by giving the page definition.
    `VolatilePage​(PageDefinition pgdef)` | Constructs a page by giving the page definition.

  - ### Uses of PageDefinition in org.zkoss.zk.ui.metainfo

    Methods in org.zkoss.zk.ui.metainfo that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | NodeInfo.`getPageDefinition()` | Returns the page definition, i.e., the root node, or null if not available.
    `PageDefinition` | PageDefinition.`getPageDefinition()` | Returns the page definition (always this).
    `static PageDefinition` | PageDefinitions.`getPageDefinition​(WebApp wapp, Locator locator, java.lang.String path)` | Returns the page definition of the specified path, or null if not found or failed to parse.
    `static PageDefinition` | PageDefinitions.`getPageDefinitionDirectly​(WebApp wapp, Locator locator, java.io.Reader reader, java.lang.String extension)` | Returns the page definition of the raw content from the specified reader; never null.
    `static PageDefinition` | PageDefinitions.`getPageDefinitionDirectly​(WebApp wapp, Locator locator, java.lang.String content, java.lang.String extension)` | Returns the page definition of the specified raw content; never null.
    `static PageDefinition` | PageDefinitions.`getPageDefinitionDirectly​(WebApp wapp, Locator locator, Document doc, java.lang.String extension)` | Returns the page definition of the specified raw content in DOM; never null.
    `PageDefinition` | Parser.`parse​(java.io.File file, java.lang.String path)` | Parses the specified file.
    `PageDefinition` | Parser.`parse​(java.io.Reader reader, java.lang.String extension)` | Parses from the specified reader.
    `PageDefinition` | Parser.`parse​(java.net.URL url, java.lang.String path)` | Parses the specified URL.
    `PageDefinition` | Parser.`parse​(Document doc, java.lang.String extension)` | Parse the raw content directly from a DOM tree.

    Methods in org.zkoss.zk.ui.metainfo with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `ComponentDefinition` | LanguageDefinition.`getMacroDefinition​(java.lang.String name, java.lang.String macroURI, boolean inline, PageDefinition pgdef)` | Instantiates and returns the component definition for the specified condition.
    `ComponentDefinition` | LanguageDefinition.`getShadowDefinition​(java.lang.String name, PageDefinition pgdef, java.lang.String templateURI)` | Instantiates and returns the component definition for the specified condition.
    `java.lang.Object` | ResponseHeaderInfo.`getValue​(PageDefinition pgdef, Page page)` | Returns the value of the response header.
    `void` | PageDefinition.`imports​(PageDefinition pgdef)` | Imports the init directives and component definitions from the specified page definition.
    `void` | PageDefinition.`imports​(PageDefinition pgdef, java.lang.String[] directives)` | Imports the specified directives from the specified page definition.
    `FunctionMapper` | FunctionMapperInfo.`newFunctionMapper​(PageDefinition pgdef, Page page)` | Creates and returns the function mapper for the specified pagedefinition and page.
    `Initiator` | InitiatorInfo.`newInitiator​(PageDefinition pgdef, Page page)` | Creates and returns the initiator, or null if no initiator is resolved.
    `VariableResolver` | VariableResolverInfo.`newVariableResolver​(PageDefinition pgdef, Page page)` | Creates and returns the variable resolver for the specified page.
    `boolean` | NamespaceParser.`parse​(Attribute attr, ComponentInfo compInfo, PageDefinition pgdef)` | Parses the the content with the current namespace parser.
    `java.lang.String` | ForwardInfo.`resolveURI​(PageDefinition pgdef, Page page)` | Evaluates and returns the URI, or null if not to forward.
    `boolean` | ResponseHeaderInfo.`shallAppend​(PageDefinition pgdef, Page page)` | Returns whether to append the response header, rather than replace.
    `java.lang.String` | HeaderInfo.`toHTML​(PageDefinition pgdef, Page page)` | Returns as HTML tag(s) representing this header element.

  - ### Uses of PageDefinition in org.zkoss.zk.ui.metainfo.impl

    Methods in org.zkoss.zk.ui.metainfo.impl with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `static ComponentDefinition` | ComponentDefinitionImpl.`newMacroDefinition​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls, java.lang.String macroURI, boolean inline)` | Constructs a macro component definition.
    `static ComponentDefinition` | ComponentDefinitionImpl.`newShadowDefinition​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls, java.lang.String templateURI)` | Constructs a shadow component definition.

    Constructors in org.zkoss.zk.ui.metainfo.impl with parameters of type PageDefinition
    Constructor | Description
    --- | ---
    `ComponentDefinitionImpl​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls)` | Constructs a native component, i.e., a component implemented by a Java class.
    `ComponentDefinitionImpl​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.String clsnm)` | Constructs a native component, i.e., a component implemented by a Java class.
    `ShadowDefinitionImpl​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.Class<? extends Component> cls)` |
    `ShadowDefinitionImpl​(LanguageDefinition langdef, PageDefinition pgdef, java.lang.String name, java.lang.String clsnm)` |

  - ### Uses of PageDefinition in org.zkoss.zk.ui.sys

    Methods in org.zkoss.zk.ui.sys that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | ExecutionCtrl.`getCurrentPageDefinition()` | Returns the current page definition, which is pushed when evaluating a page (from a page definition).
    `PageDefinition` | UiFactory.`getPageDefinition​(RequestInfo ri, java.lang.String path)` | Returns the page definition of the specified path, or null if not found.
    `PageDefinition` | UiFactory.`getPageDefinitionDirectly​(RequestInfo ri, java.io.Reader reader, java.lang.String extension)` | Returns the page definition of the specified reader; never null.
    `PageDefinition` | UiFactory.`getPageDefinitionDirectly​(RequestInfo ri, java.lang.String content, java.lang.String extension)` | Returns the page definition of the specified content; never null.
    `PageDefinition` | UiFactory.`getPageDefinitionDirectly​(RequestInfo ri, Document content, java.lang.String extension)` | Returns the page definition of the specified content; never null.

    Methods in org.zkoss.zk.ui.sys with parameters of type PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `Component[]` | UiEngine.`createComponents​(Execution exec, PageDefinition pagedef, Page page, Component parent, Component insertBefore, VariableResolver resolver, java.util.Map<?,​?> arg)` | Creates components from the specified page and definition.
    `void` | UiEngine.`execNewPage​(Execution exec, PageDefinition pagedef, Page page, java.io.Writer out)` | Creates components specified in the given page definition.
    `Page` | UiFactory.`newPage​(RequestInfo ri, PageDefinition pagedef, java.lang.String path)` | Creates an instance of `Page` for the specified page definition.
    `void` | ExecutionCtrl.`setCurrentPageDefinition​(PageDefinition pgdef)` | Sets the current page definition.

  - ### Uses of PageDefinition in org.zkoss.zk.xel

    Methods in org.zkoss.zk.xel that return PageDefinition
    Modifier and Type | Method | Description
    --- | --- | ---
    `PageDefinition` | EvaluatorRef.`getPageDefinition()` | Returns the page definition of this reference, or null if not available.