Package org.apache.juneau.console

Class ModelAction

java.lang.Object

org.apache.juneau.console.ModelAction

public final class ModelAction
extends Object

A click-triggered action on an element: an icon button that calls a handler.

Example:

ModelAction.of("archive").icon("archive").label("Archive").handler("orders.archive");

Since:

10.0.0

Method Summary

Modifier and Type	Method	Description
ModelAction	handler(String name)	Sets the handler by name.
ModelAction	handler(HandlerRef ref)	Sets the handler.
ModelAction	icon(String v)	Sets the icon (a sprite name).
String	id()	Returns the action id.
ModelAction	label(String v)	Sets the visible label.
static ModelAction	of(String id)	Starts an action.
ModelAction	payload(Map<String,Object> v)	Sets the payload merged into the event payload.
Map<String,Object>	toMap()	Serializes to the contract shape.
ModelAction	tone(String v)	Sets the tone.
ModelAction	tooltip(String v)	Sets the tooltip.

Methods inherited from class java.lang.Object

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

Method Details

of

public static ModelAction of(String id)

Starts an action.

Parameters:

id - The action id, unique per element.

Returns:

A new action.

Throws:

IllegalArgumentException - If the id is malformed.

id

public String id()

Returns the action id.

Returns:

The id.

icon

public ModelAction icon(String v)

Sets the icon (a sprite name).

Parameters:

v - The icon.

Returns:

This object.

label

public ModelAction label(String v)

Sets the visible label.

Parameters:

v - The label.

Returns:

This object.

tooltip

public ModelAction tooltip(String v)

Sets the tooltip.

Parameters:

v - The tooltip.

Returns:

This object.

tone

public ModelAction tone(String v)

Sets the tone.

Parameters:

v - The tone.

Returns:

This object.

handler

public ModelAction handler(String name)

Sets the handler by name.

Parameters:

name - A registered handler name or a listed built-in (juneau.refresh).

Returns:

This object.

Throws:

IllegalArgumentException - If the name is malformed.

handler

public ModelAction handler(HandlerRef ref)

Sets the handler.

Parameters:

ref - The handler reference.

Returns:

This object.

payload

public ModelAction payload(Map<String,Object> v)

Sets the payload merged into the event payload.

Parameters:

v - The payload.

Returns:

This object.

toMap

public Map<String,Object> toMap()

Serializes to the contract shape.

Returns:

The map, with "type":"handler".

Throws:

IllegalStateException - If no handler was set.