org.rendersnake.tools

Class DebugHtmlCanvas

java.lang.Object

org.rendersnake.HtmlCanvas

org.rendersnake.ext.servlet.HtmlServletCanvas

org.rendersnake.tools.DebugHtmlCanvas

public class DebugHtmlCanvas
extends HtmlServletCanvas

DebugHtmlCanvas is a special HtmlCanvas that can render inspector wrappers around component on a HTML page. Its purpose is to reveal the structure of a page by displaying debugging information.

Author:

ernestmicklei

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled
int	renderCount

Fields inherited from class org.rendersnake.ext.servlet.HtmlServletCanvas

request, response

Fields inherited from class org.rendersnake.HtmlCanvas

HTML_ESCAPE_HANDLER, INITIAL_STACK_CAPACITY, NO_ESCAPE, openTagStack, out

Constructor Summary

Constructors

Constructor and Description
DebugHtmlCanvas(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Writer out)

Method Summary

Modifier and Type	Method and Description
HtmlCanvas	_body() Closes the body tag.
HtmlCanvas	body() Opens the body tag, without any attributes.
HtmlCanvas	body(CharactersWriteable attrs) Opens the body tag, with the specified attributes.
protected PageContext	createPageContext() Return a new PageContext for storing component-scoped variables.
HtmlCanvas	render(Renderable component) Render the component using the receiver.

Methods inherited from class org.rendersnake.ext.servlet.HtmlServletCanvas

createLocalCanvas, hasAjaxRequest

Methods inherited from class org.rendersnake.HtmlCanvas

_a, _abbr, _acronym, _address, _applet, _article, _aside, _audio, _b, _bdo, _big, _blockquote, _button, _canvas, _caption, _cdata, _cite, _code, _colgroup, _command, _datalist, _dd, _del, _details, _dfn, _dir, _div, _dl, _dt, _em, _embed, _fieldset, _figcaption, _figure, _font, _footer, _form, _frameset, _h1, _h2, _h3, _h4, _h5, _h6, _head, _header, _hgroup, _html, _i, _if, _iframe, _ins, _kbd, _keygen, _label, _legend, _li, _main, _map, _mark, _menu, _meter, _nav, _noframes, _noscript, _object, _ol, _optgroup, _option, _output, _p, _pre, _progress, _q, _rp, _rt, _ruby, _s, _samp, _script, _section, _select, _small, _source, _span, _strike, _strong, _style, _sub, _summary, _sup, _table, _tbody, _td, _textarea, _tfoot, _th, _thead, _time, _title, _tr, _tt, _u, _ul, _var, _video, _wbr, a, a, abbr, abbr, acronym, acronym, address, address, applet, applet, area, article, article, aside, aside, attributes, audio, audio, b, b, base, basefont, basefont, bdo, bdo, big, big, blockquote, blockquote, br, br, button, button, canvas, canvas, caption, caption, cdata, center, cite, cite, close, close, code, code, col, colgroup, colgroup, command, command, content, content, content, createMacros, datalist, datalist, dd, dd, del, del, details, details, dfn, dfn, dir, dir, div, div, dl, dl, dt, dt, em, em, embed, embed, fieldset, fieldset, figcaption, figcaption, figure, figure, font, font, footer, footer, form, form, frame, frameset, frameset, getOutputWriter, getPageContext, getPathParameters, getRequestParameters, getSession, h1, h1, h2, h2, h3, h3, h4, h4, h5, h5, h6, h6, hasPageContext, head, head, header, header, hgroup, hgroup, hr, hr, html, html, i, i, if_, iframe, iframe, img, input, input, ins, ins, isindex, isindex, kbd, kbd, keygen, keygen, label, label, legend, legend, li, li, link, macros, main, main, map, map, mark, mark, menu, menu, meta, meter, meter, nav, nav, nextId, noframes, noframes, noscript, noscript, object, object, ol, ol, optgroup, optgroup, option, option, output, output, p, p, param, pre, pre, progress, progress, q, q, render_if, rp, rp, rt, rt, ruby, ruby, s, s, samp, samp, script, script, section, section, select, select, small, small, source, source, span, span, strike, strike, strong, strong, style, style, sub, sub, summary, summary, sup, sup, table, table, tag_close, tag, tag, tbody, tbody, td, td, textarea, textarea, tfoot, tfoot, th, th, thead, thead, time, time, title, title, toHtml, toString, tr, tr, tt, tt, u, u, ul, ul, var, var, video, video, wbr, wbr, write, write, write, write

Methods inherited from class java.lang.Object

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

Field Detail

enabled

public boolean enabled

renderCount

public int renderCount

Constructor Detail

DebugHtmlCanvas

public DebugHtmlCanvas(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       Writer out)

Method Detail

render

public HtmlCanvas render(Renderable component)
                  throws IOException

Description copied from class: HtmlCanvas

Render the component using the receiver. If available, prepare the pageContext for accessing variables by the components.

Overrides:

render in class HtmlCanvas

Parameters:

component - a Renderable instance | null

Returns:

the receiver this HtmlCanvas instance.

Throws:

IOException - in case of an I/O error.

body

public HtmlCanvas body()
                throws IOException

Description copied from class: HtmlCanvas

Opens the body tag, without any attributes.

Close this tag by calling HtmlCanvas._body() (the end tag is optional).

Overrides:

body in class HtmlCanvas

Returns:

the receiver, this HtmlCanvas instance.

Throws:

IOException - in case of an I/O error.

body

public HtmlCanvas body(CharactersWriteable attrs)
                throws IOException

Description copied from class: HtmlCanvas

Opens the body tag, with the specified attributes.

Close this tag by calling HtmlCanvas._body() (the end tag is optional).

This tag supports the following attributes:

background

texture tile for document background

text

document text color

link

color of links

vlink

color of visited links

alink

color of selected links

id

document-wide unique id

class

space separated list of classes

dir

direction for weak/neutral text

lang

language code

title

advisory title

style

associated style info

bgcolor

document background color

onload

the document has been loaded

onunload

the document has been removed

onclick

a pointer button was clicked

ondblclick

a pointer button was double clicked

onmousedown

a pointer button was pressed down

onmouseup

a pointer button was released

onmouseover

a pointer was moved onto

onmousemove

a pointer was moved within

onmouseout

a pointer was moved away

onkeypress

a key was pressed and released

onkeydown

a key was pressed down

onkeyup

a key was released

Overrides:

body in class HtmlCanvas

Parameters:

attrs - the CharactersWriteable, or null if none.

Returns:

the receiver, this HtmlCanvas instance.

Throws:

IOException - in case of an I/O error.

_body

public HtmlCanvas _body()
                 throws IOException

Description copied from class: HtmlCanvas

Closes the body tag.

Overrides:

_body in class HtmlCanvas

Throws:

IOException - in case of an I/O error while writing the end tag.

createPageContext

protected PageContext createPageContext()

Return a new PageContext for storing component-scoped variables. Create one that logs all set calls.

Overrides:

createPageContext in class HtmlCanvas

Returns:

a new LoggingPageContext