Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.tapestry.html
Class Shell

java.lang.Object
  extended by org.apache.hivemind.impl.BaseLocatable
      extended by org.apache.tapestry.AbstractComponent
          extended by org.apache.tapestry.html.Shell
All Implemented Interfaces:
org.apache.hivemind.Locatable, org.apache.hivemind.LocationHolder, IComponent, IDirectEvent, Component, IRender
public abstract class Shell
extends AbstractComponent

Component for creating a standard 'shell' for a page, which comprises the <html> and <head> portions of the page. [ Component Reference ]

Specifically does not provide a <body> tag, that is usually accomplished using a Body  component.

Author:
Howard Lewis Ship

Field Summary
static String SHELL_ATTRIBUTE
           
 
Fields inherited from class org.apache.tapestry.AbstractComponent
_body, _bodyCount
 
Constructor Summary
Shell()
           
 
Method Summary
 void addRelation(RelationBean relation)
          Adds a relation (stylesheets, favicon, e.t.c.) to the page.
protected  void cleanupAfterRender(IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.
static Shell get(IRequestCycle cycle)
          Retrieves the Shell that was stored into the request cycle.
abstract  IRender getAjaxDelegate()
           
abstract  IApplicationSpecification getApplicationSpecification()
           
abstract  IRender getBaseTagWriter()
           
abstract  ResponseBuilder getBuilder()
           
abstract  StringBuffer getContentBuffer()
           
abstract  IRender getDelegate()
           
abstract  String getDoctype()
           
abstract  IEngineService getPageService()
           
abstract  boolean getRaw()
           
abstract  int getRefresh()
           
abstract  List getRelations()
           
abstract  boolean getRenderBaseTag()
           
abstract  boolean getRenderContentType()
           
abstract  String getSearchIds()
           
abstract  IAsset getStylesheet()
           
abstract  Object getStylesheets()
           
abstract  String getTitle()
           
abstract  ValueConverter getValueConverter()
           
 void includeAdditionalContent(String content)
          Include additional content in the header of a page.
abstract  boolean isDisableCaching()
           
abstract  boolean isDisableTapestryMeta()
           
protected  void renderComponent(IMarkupWriter writer, IRequestCycle cycle)
          Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to actually render the component (with any parameter values already set).
abstract  void setContentBuffer(StringBuffer buffer)
           
abstract  void setRelations(List relations)
           
abstract  void setSearchIds(String ids)
           
 
Methods inherited from class org.apache.tapestry.AbstractComponent
addAsset, addBody, addComponent, checkActiveLock, enterActiveState, equals, finishLoad, finishLoad, generateClientId, getAsset, getAssets, getBeans, getBinding, getBindingNames, getBindings, getBody, getBodyCount, getBoundId, getClientId, getComponent, getComponents, getContainedComponent, getContainedRenderers, getContainer, getEventInvoker, getExtendedId, getId, getIdPath, getInnerRenderers, getListeners, getMessages, getNamespace, getPage, getRenderWorker, getSpecification, getSpecifiedId, getTemplateTagName, hasEvents, hashCode, isInActiveState, isParameterBound, isRendering, isStateful, pageEndRender, peekClientId, prepareForRender, render, renderBody, renderIdAttribute, renderInformalParameters, setBinding, setClientId, setContainedComponent, setContainer, setHasEvents, setId, setNamespace, setPage, setTemplateTagName, toString, triggerEvent
 
Methods inherited from class org.apache.hivemind.impl.BaseLocatable
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.hivemind.LocationHolder
setLocation
 
Methods inherited from interface org.apache.hivemind.Locatable
getLocation
 

Field Detail

SHELL_ATTRIBUTE

public static final String SHELL_ATTRIBUTE
See Also:
Constant Field Values
Constructor Detail

Shell

public Shell()
Method Detail

renderComponent

protected void renderComponent(IMarkupWriter writer,
                               IRequestCycle cycle)
Description copied from class: AbstractComponent
Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)to actually render the component (with any parameter values already set). This is the method that subclasses must implement.

Specified by:
renderComponent in class AbstractComponent

cleanupAfterRender

protected void cleanupAfterRender(IRequestCycle cycle)
Description copied from class: AbstractComponent
Invoked by AbstractComponent.render(IMarkupWriter, IRequestCycle)after the component renders.

Overrides:
cleanupAfterRender in class AbstractComponent

get

public static Shell get(IRequestCycle cycle)
Retrieves the Shell that was stored into the request cycle. This allows components wrapped by the Shell to locate it and access the services it provides.

Since:
4.1.1

addRelation

public void addRelation(RelationBean relation)
Adds a relation (stylesheets, favicon, e.t.c.) to the page.

Since:
4.1.1

includeAdditionalContent

public void includeAdditionalContent(String content)
Include additional content in the header of a page.

Parameters:
content -
Since:
4.1.1

isDisableCaching

public abstract boolean isDisableCaching()

getAjaxDelegate

public abstract IRender getAjaxDelegate()

getDelegate

public abstract IRender getDelegate()

getRefresh

public abstract int getRefresh()

getStylesheet

public abstract IAsset getStylesheet()

getStylesheets

public abstract Object getStylesheets()

getTitle

public abstract String getTitle()

getDoctype

public abstract String getDoctype()

getRenderContentType

public abstract boolean getRenderContentType()

isDisableTapestryMeta

public abstract boolean isDisableTapestryMeta()

getBuilder

public abstract ResponseBuilder getBuilder()

getValueConverter

public abstract ValueConverter getValueConverter()
Since:
4.0

getPageService

public abstract IEngineService getPageService()
Since:
4.0

getApplicationSpecification

public abstract IApplicationSpecification getApplicationSpecification()
Since:
4.0

getBaseTagWriter

public abstract IRender getBaseTagWriter()
Since:
4.0

getRenderBaseTag

public abstract boolean getRenderBaseTag()
Since:
4.0.1

getRaw

public abstract boolean getRaw()
Since:
4.0.3

getRelations

public abstract List getRelations()
Since:
4.1.1

setRelations

public abstract void setRelations(List relations)
Since:
4.1.1

getContentBuffer

public abstract StringBuffer getContentBuffer()
Since:
4.1.1

setContentBuffer

public abstract void setContentBuffer(StringBuffer buffer)
Since:
4.1.1

getSearchIds

public abstract String getSearchIds()
Since:
4.1.4

setSearchIds

public abstract void setSearchIds(String ids)
Since:
4.1.4
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2006-2008 Apache Software Foundation. All Rights Reserved.