org.mmbase.framework

Class RenderHints

java.lang.Object

org.mmbase.framework.RenderHints

public class RenderHints
extends Object

A Renderer is used by Renderer.render(org.mmbase.util.functions.Parameters, java.io.Writer, org.mmbase.framework.RenderHints), with a RenderHints object, which gives to Renderer implementation some instructions about how to render excactly, since it may vary a bit in that.

Since:

MMBase-1.9

Version:

$Id$

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RenderHints.Mode

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
RenderHints(Renderer renderer, WindowState state, String id, String clazz, RenderHints.Mode mode)

Method Summary

Modifier and Type	Method and Description
String	getId() A string which can identify the returned rendition in the current request.
RenderHints.Mode	getMode()
Renderer	getRenderer() The renderer where these hints are hinting for.
String	getStyleClass() The framework may request to add a class for styling to the outermost produced XML tag.
WindowState	getWindowState() The window state is a hint on how big a part the rendering can take of the available area.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

RenderHints

public RenderHints(Renderer renderer,
                   WindowState state,
                   String id,
                   String clazz,
                   RenderHints.Mode mode)

Method Detail

getRenderer

public Renderer getRenderer()

The renderer where these hints are hinting for.

getWindowState

public WindowState getWindowState()

The window state is a hint on how big a part the rendering can take of the available area. Thins like WindowState.MAXIMIZED or WindowState.NORMAL.

getId

public String getId()

A string which can identify the returned rendition in the current request. This can e.g. be used to fill an 'id' attribute of the outermost produced XML tag.

getStyleClass

public String getStyleClass()

The framework may request to add a class for styling to the outermost produced XML tag.

getMode

public RenderHints.Mode getMode()