Package com.opensymphony.module.sitemesh

Interface Page

All Known Subinterfaces:
HTMLPage
All Known Implementing Classes:
AbstractHTMLPage, AbstractPage, Content2HTMLPage, FastPage, PartialPageParserHtmlPage, PartialPageParserPage, 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.

Author:
Joe Walnes

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addProperty(String name, String value)
    Manually add a property to page.
    String
    getBody()
    Convenience method to return the contents of the <body> tag.
    boolean
    getBooleanProperty(String name)
    Get a property embedded into the Page as a boolean.
    int
    getIntProperty(String name)
    Get a property embedded into the Page as an int.
    long
    getLongProperty(String name)
    Get a property embedded into the Page as a long.
    String
    getPage()
    Convenience method to return the contents of the Page in its original format.
    Map<String,String>
    getProperties()
    Get a Map representing all the properties in the Page.
    String
    getProperty(String name)
    Get a property embedded into the Page as a String.
    String[]
    getPropertyKeys()
    Get all available property keys for the Page.
    javax.servlet.http.HttpServletRequest
    getRequest()
    Deprecated.
    Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.
    String
    getTitle()
    Get the Title of the document.
    boolean
    isPropertySet(String name)
    Determine whether a property embedded into the Page has been set.
    void
    setRequest(javax.servlet.http.HttpServletRequest request)
    Create snapshot of Request.
    void
    writeBody(Writer out)
    Write the contents of the <body> tag.
    void
    writePage(Writer out)
    Write the entire contents of the Page, in the format before it was parsed, to the Writer.

  • Method Details

    • 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 - Signals that an I/O exception has occurred.

    • getPage

      String getPage()
      Convenience method to return the contents of the Page in its original format.
      Returns:
      the page
      Since:
      2.1.1
      See Also:

    • writeBody

      void writeBody(Writer out) throws IOException
      Write the contents of the <body> tag.
      Parameters:
      out - the out
      Throws:
      IOException - Signals that an I/O exception has occurred.

    • getBody

      String getBody()
      Convenience method to return the contents of the <body> tag.
      Returns:
      the body
      Since:
      2.1.1
      See Also:

    • getTitle

      String getTitle()
      Get the Title of the document.
      Returns:
      the title

    • 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<String,String> getProperties()
      Get a Map representing all the properties in the Page.
      Returns:
      Properties map

    • getRequest

      @Deprecated 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.
      Returns:
      the request

    • 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()
      Parameters:
      request - the new request

    • addProperty

      void addProperty(String name, String value)
      Manually add a property to page.
      Parameters:
      name - the name
      value - the value