org.apache.juneau.html

Class HtmlWidgetVar

java.lang.Object

org.apache.juneau.svl.Var

org.apache.juneau.svl.SimpleVar

org.apache.juneau.html.HtmlWidgetVar

public class HtmlWidgetVar
extends SimpleVar

HTML widget variable resolver.

The format for this var is "$W{widgetName}".

Widgets are simple class that produce some sort of string based on a passed-in HTTP request.

They're registered via the following mechanisms:

• @HtmlDocConfig(widgets)

• Overview > juneau-rest-server > SVL Variables

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The name of this variable.
static String	SESSION_htmlWidgets The name of the session or context object that identifies the object containing the widgets to resolve.

Constructor Summary

Constructors

Constructor and Description
HtmlWidgetVar() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	canResolve(VarResolverSession session) Returns true if this variable can be resolved in the specified session.
String	resolve(VarResolverSession session, String key) The interface that needs to be implemented for subclasses of SimpleVar.

Methods inherited from class org.apache.juneau.svl.SimpleVar

resolveTo

Methods inherited from class org.apache.juneau.svl.Var

allowNested, allowRecurse, doResolve, getName

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_htmlWidgets

public static final String SESSION_htmlWidgets

The name of the session or context object that identifies the object containing the widgets to resolve.

See Also:

Constant Field Values

NAME

public static final String NAME

The name of this variable.

See Also:

Constant Field Values

Constructor Detail

HtmlWidgetVar

public HtmlWidgetVar()

Constructor.

Method Detail

resolve

public String resolve(VarResolverSession session,
                      String key)
               throws Exception

Description copied from class: Var

The interface that needs to be implemented for subclasses of SimpleVar.

Specified by:

resolve in class Var

Parameters:

session - The session object used for a single instance of a var resolution.

key - The inside argument of the variable.

Returns:

The resolved value.

Throws:

Exception - Any exception can be thrown.

canResolve

public boolean canResolve(VarResolverSession session)

Description copied from class: Var

Returns true if this variable can be resolved in the specified session.

For example, some variable cannot resolve unless specific context or session objects are available.

Overrides:

canResolve in class Var

Parameters:

session - The current session.

Returns:

true if this variable can be resolved in the specified session.