GSPSitemeshPage (Grails 2.3.8)
Date: 2014-04-24

Overview | Package | Class | Deprecated | Index | Help
| Groovy Documentation
| FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.codehaus.groovy.grails.web.sitemesh
[Java] Class GSPSitemeshPage

    java.lang.Object
      com.opensymphony.module.sitemesh.parser.AbstractPage
          com.opensymphony.module.sitemesh.parser.AbstractHTMLPage
              org.codehaus.groovy.grails.web.sitemesh.GSPSitemeshPage

All Implemented Interfaces:
  com.opensymphony.sitemesh.Content

    public class GSPSitemeshPage
    extends com.opensymphony.module.sitemesh.parser.AbstractHTMLPage

Grails/GSP specific implementation of Sitemesh's AbstractHTMLPage g:capture* tags in RenderTagLib are used to capture head, meta, title, component & body contents. No html parsing is required for templating since capture tags are added at GSP compilation time.

Authors:
  Lari Hotari, Sagire Software Oy

See Also:
  SitemeshPreprocessor

Constructor Summary
`GSPSitemeshPage()`
`GSPSitemeshPage(boolean renderingLayout)`

Method Summary
`void` | `addProperty(java.lang.String name, java.lang.Object value)`
`void` | `addProperty(java.lang.String name, java.lang.String value)`
`static com.opensymphony.module.sitemesh.HTMLPage` | `content2htmlPage(com.opensymphony.sitemesh.Content content)`
`java.lang.String` | `getBody()`
`java.lang.Object` | `getContentBuffer(java.lang.String name)` @param name propertyName of contentBuffer (with "page." prefix)
`java.lang.String` | `getHead()`
`java.lang.String` | `getPage()`
`StreamCharBuffer` | `getTitleBuffer()`
`boolean` | `isTitleCaptured()`
`boolean` | `isUsed()`
`int` | `originalLength()`
`void` | `reset()`
`void` | `setBodyBuffer(StreamCharBuffer bodyBuffer)`
`void` | `setContentBuffer(java.lang.String tagName, StreamCharBuffer buffer)` @param tagName "tagName" name of buffer (without "page." prefix)
`void` | `setHeadBuffer(StreamCharBuffer headBuffer)`
`void` | `setPageBuffer(StreamCharBuffer pageBuffer)`
`void` | `setTitleBuffer(StreamCharBuffer titleBuffer)`
`void` | `setTitleCaptured(boolean titleCaptured)`
`void` | `setUsed(boolean used)`
`void` | `writeBody(java.io.Writer out)`
`void` | `writeHead(java.io.Writer out)`
`void` | `writeOriginal(java.io.Writer writer)`
`void` | `writePage(java.io.Writer out)`

Methods inherited from class com.opensymphony.module.sitemesh.parser.AbstractHTMLPage
com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#writeHead(java.io.Writer), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#isFrameSet(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#setFrameSet(boolean), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getContentLength(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getBooleanProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getProperties(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#addProperty(java.lang.String, java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getIntProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getTitle(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getRequest(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#setRequest(javax.servlet.http.HttpServletRequest), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getPage(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getBody(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#writeBody(java.io.Writer), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getPropertyKeys(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#writePage(java.io.Writer), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getLongProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#isPropertySet(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#wait(long, int), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#wait(long), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#wait(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#equals(java.lang.Object), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#toString(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#hashCode(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getClass(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#notify(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#notifyAll(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#getHead(), com.opensymphony.module.sitemesh.parser.AbstractHTMLPage#writeBody(java.io.Writer)

Methods inherited from class com.opensymphony.module.sitemesh.parser.AbstractPage
com.opensymphony.module.sitemesh.parser.AbstractPage#getContentLength(), com.opensymphony.module.sitemesh.parser.AbstractPage#getBooleanProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#getProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#getProperties(), com.opensymphony.module.sitemesh.parser.AbstractPage#addProperty(java.lang.String, java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#getIntProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#getTitle(), com.opensymphony.module.sitemesh.parser.AbstractPage#getRequest(), com.opensymphony.module.sitemesh.parser.AbstractPage#setRequest(javax.servlet.http.HttpServletRequest), com.opensymphony.module.sitemesh.parser.AbstractPage#getPage(), com.opensymphony.module.sitemesh.parser.AbstractPage#getBody(), com.opensymphony.module.sitemesh.parser.AbstractPage#writeBody(java.io.Writer), com.opensymphony.module.sitemesh.parser.AbstractPage#getPropertyKeys(), com.opensymphony.module.sitemesh.parser.AbstractPage#writePage(java.io.Writer), com.opensymphony.module.sitemesh.parser.AbstractPage#getLongProperty(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#isPropertySet(java.lang.String), com.opensymphony.module.sitemesh.parser.AbstractPage#wait(long, int), com.opensymphony.module.sitemesh.parser.AbstractPage#wait(long), com.opensymphony.module.sitemesh.parser.AbstractPage#wait(), com.opensymphony.module.sitemesh.parser.AbstractPage#equals(java.lang.Object), com.opensymphony.module.sitemesh.parser.AbstractPage#toString(), com.opensymphony.module.sitemesh.parser.AbstractPage#hashCode(), com.opensymphony.module.sitemesh.parser.AbstractPage#getClass(), com.opensymphony.module.sitemesh.parser.AbstractPage#notify(), com.opensymphony.module.sitemesh.parser.AbstractPage#notifyAll()

Constructor Detail

### GSPSitemeshPage

    public GSPSitemeshPage()

### GSPSitemeshPage

    public GSPSitemeshPage(boolean renderingLayout)

Method Detail

### addProperty

    public void addProperty(java.lang.String name, java.lang.Object value)

### addProperty

    @java.lang.Override
    public void addProperty(java.lang.String name, java.lang.String value)

### content2htmlPage

    public static com.opensymphony.module.sitemesh.HTMLPage content2htmlPage(com.opensymphony.sitemesh.Content content)

### getBody

    @java.lang.Overrideif (bodyBuffer != null) {
    public java.lang.String getBody()

### getContentBuffer

    public java.lang.Object getContentBuffer(java.lang.String name)

  Parameters:
    `name` - propertyName of contentBuffer (with "page." prefix)
  Returns:
    the buffer for the specified name

### getHead

    public java.lang.String getHead()

### getPage

    @java.lang.Overrideif (pageBuffer != null) {
    public java.lang.String getPage()

### getTitleBuffer

    public StreamCharBuffer getTitleBuffer()

### isTitleCaptured

    public boolean isTitleCaptured()

### isUsed

    public boolean isUsed()

### originalLength

    public int originalLength()

### reset

    public void reset()

### setBodyBuffer

    public void setBodyBuffer(StreamCharBuffer bodyBuffer)

### setContentBuffer

    public void setContentBuffer(java.lang.String tagName, StreamCharBuffer buffer)

  Parameters:
    `tagName` - "tagName" name of buffer (without "page." prefix)
    buffer

### setHeadBuffer

    public void setHeadBuffer(StreamCharBuffer headBuffer)

### setPageBuffer

    public void setPageBuffer(StreamCharBuffer pageBuffer)

### setTitleBuffer

    public void setTitleBuffer(StreamCharBuffer titleBuffer)

### setTitleCaptured

    public void setTitleCaptured(boolean titleCaptured)

### setUsed

    public void setUsed(boolean used)

### writeBody

    @java.lang.Overridepublic void writeBody(Writer out) throws IOException {
    public void writeBody(java.io.Writer out)

### writeHead

    @java.lang.Override
    public void writeHead(java.io.Writer out)

### writeOriginal

    public void writeOriginal(java.io.Writer writer)

### writePage

    @java.lang.Overrideif (pageBuffer != null) {
    public void writePage(java.io.Writer out)

Groovy Documentation