de.smartics.properties.admin.resources.representation.html.share
Class AbstractHtmlRepresentationRenderer<T>

java.lang.Object
  de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer<T>
      de.smartics.properties.admin.resources.representation.html.share.AbstractHtmlRepresentationRenderer<T>

Type Parameters:

T - the type of the resource the renderer is rendering representations for.

All Implemented Interfaces:

de.smartics.resteasy.hypermedia.renderer.RepresentationRenderer<T>

Direct Known Subclasses:

ApiServicesHtmlRepresentationRenderer, ConfigurationKeysHtmlRepresentationRenderer, ExceptionHtmlRepresentationRenderer, JndiHtmlRepresentationRenderer, PropertyDescriptorHtmlRepresentationRenderer, PropertyDescriptorsHtmlRepresentationRenderer, PropertyHtmlRepresentationRenderer, PropertyKeysHtmlRepresentationRenderer, SecurityHtmlRepresentationRenderer

public abstract class AbstractHtmlRepresentationRenderer<T>
     
     

      
      extends 
      
      AbstractRepresentationRenderer<T>
     
     

Base implementation for HTML documents.

Field Summary

protected de.smartics.html5.jatl.HtmlFactory	factory The factory to access output properties.
protected de.smartics.html5.jatl.Html	html The HTML instance to create HTML documents.
protected de.smartics.html5.jatl.HtmlResourceContext	htmlContext The context information to render the representation.
protected HtmlPathHelper	pathHelper Helper to localize application specific resources.

Fields inherited from class de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer

breadcrumb, characterEncoding, entityStream, htmlUtils, linkDescriptorFactory

Constructor Summary

protected

AbstractHtmlRepresentationRenderer(de.smartics.html5.jatl.HtmlResourceContext htmlContext, OutputStream entityStream) Default constructor using a stream.

Method Summary

protected abstract void	bodyContents() The contents to write to the HTML body.
protected abstract List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor>	breadcrumbLinks() Returns the breadcrumbs.
protected void	close() Releases any resources held by the renderer.
protected abstract String	getTitle() Returns the title to the page.
protected void	httpBody() Redners the HTTP body.
protected void	renderPageTitle(String subTitle) Renders the subtitle within the page body.

Methods inherited from class de.smartics.properties.admin.resources.representation.share.AbstractRepresentationRenderer

render, renderAdditionalHttpHeader, renderHttpHeaderLink

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

htmlContext

protected final de.smartics.html5.jatl.HtmlResourceContext htmlContext

The context information to render the representation.

factory

protected final de.smartics.html5.jatl.HtmlFactory factory

The factory to access output properties.

html

protected final de.smartics.html5.jatl.Html html

The HTML instance to create HTML documents.

pathHelper

protected final HtmlPathHelper pathHelper

Helper to localize application specific resources.

Constructor Detail

AbstractHtmlRepresentationRenderer

protected AbstractHtmlRepresentationRenderer(de.smartics.html5.jatl.HtmlResourceContext htmlContext,
                                             OutputStream entityStream)

Default constructor using a stream.

Parameters:

htmlContext - the context information to render the representation.

entityStream - the stream to write to.

Method Detail

httpBody

protected final void httpBody()

Description copied from class: AbstractRepresentationRenderer

Redners the HTTP body.

Specified by:

httpBody in class AbstractRepresentationRenderer<T>

getTitle

protected abstract String getTitle()

Returns the title to the page.

Returns:

the title to the page.

renderPageTitle

protected void renderPageTitle(String subTitle)

Renders the subtitle within the page body.

Parameters:

subTitle - the optional sub title to render.

breadcrumbLinks

protected abstract List<de.smartics.resteasy.hypermedia.renderer.LinkDescriptor> breadcrumbLinks()

Returns the breadcrumbs.

Returns:

the list of breadcrumb links.

bodyContents

protected abstract void bodyContents()

The contents to write to the HTML body.

close

protected final void close()

Description copied from class: AbstractRepresentationRenderer

Releases any resources held by the renderer.

Specified by:

close in class AbstractRepresentationRenderer<T>