Package com.opensymphony.module.sitemesh

Interface Page

  • All Known Subinterfaces:
    HTMLPage
    All Known Implementing Classes:
    AbstractHTMLPage, AbstractPage, Content2HTMLPage, FastPage, TokenizedHTMLPage
    public interface Page
    The Page object wraps the contents of the original (undecorated) page.

    The original data in its entirity can be written using the writePage() methods. It may also contain a set of properties - these vary among different PageParser implementations.

    Typically a Page is no use to a Decorator as it needs specific details relevant to the content-type of that page (e.g. HTML pages). The appropriate PageParser is responsible for returning extended implementations of pages such as HTMLPage which are of more use to the Decorator. New media types (e.g. WML) could be added to the system by extending Page and implementing an appropriate PageParser.

    Version:
    $Revision: 1.5 $
    Author:
    Joe Walnes

    • Method Detail

      • writePage

        void writePage​(Writer out)
        throws IOException
        Write the entire contents of the Page, in the format before it was parsed, to the Writer.
        Parameters:
        out - Writer to write to.
        Throws:
        IOException - Rethrown if cannot write to writer.

      • getTitle

        String getTitle()
        Get the Title of the document

      • getContentLength

        int getContentLength()
        Length of the Page, in the format before it was parsed.
        Returns:
        Length of page data (in number of bytes).

      • getProperty

        String getProperty​(String name)
        Get a property embedded into the Page as a String.
        Parameters:
        name - Name of property
        Returns:
        Property value

      • getIntProperty

        int getIntProperty​(String name)
        Get a property embedded into the Page as an int. Returns 0 if property not specified or not valid number.
        Parameters:
        name - Name of property
        Returns:
        Property value

      • getLongProperty

        long getLongProperty​(String name)
        Get a property embedded into the Page as a long. Returns 0L if property not specified or not valid number.
        Parameters:
        name - Name of property
        Returns:
        Property value

      • getBooleanProperty

        boolean getBooleanProperty​(String name)
        Get a property embedded into the Page as a boolean. Returns true if value starts with '1', 't' or 'y' (case-insensitive) - otherwise returns false.
        Parameters:
        name - Name of property
        Returns:
        Property value

      • isPropertySet

        boolean isPropertySet​(String name)
        Determine whether a property embedded into the Page has been set.
        Parameters:
        name - Name of property
        Returns:
        Whether it has been set

      • getPropertyKeys

        String[] getPropertyKeys()
        Get all available property keys for the Page.
        Returns:
        Property keys

      • getProperties

        Map getProperties()
        Get a Map representing all the properties in the Page.
        Returns:
        Properties map

      • getRequest

        javax.servlet.http.HttpServletRequest getRequest()
        Deprecated.
        Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.
        Return the request of the original page.

      • setRequest

        void setRequest​(javax.servlet.http.HttpServletRequest request)
        Create snapshot of Request. Subsequent modifications to the request by the servlet container will not be returned by getRequest()

      • addProperty

        void addProperty​(String name,
                 String value)
        Manually add a property to page.