com.google.gerrit.extensions.webui

Class UiAction.Description

java.lang.Object

com.google.gerrit.extensions.webui.UiAction.Description

Enclosing interface:

UiAction<R extends RestResource>

public static class UiAction.Description
extends Object

Describes an action invokable through the web interface.

Constructor Summary

Constructors

Constructor and Description
Description()

Method Summary

Modifier and Type	Method and Description
BooleanCondition	getEnabledCondition()
String	getId()
String	getLabel()
String	getMethod()
String	getTitle()
BooleanCondition	getVisibleCondition()
boolean	isEnabled()
boolean	isVisible()
UiAction.Description	setEnabled(boolean enabled) Set if the button should be invokable (true), or greyed out (false).
UiAction.Description	setEnabled(BooleanCondition enabled) Set if the button should be invokable (true), or greyed out (false).
UiAction.Description	setLabel(String label) Set the label to appear on the button to activate this action.
UiAction.Description	setTitle(String title) Set the tool-tip text to appear when the mouse hovers on the button.
UiAction.Description	setVisible(boolean visible) Set if the action's button is visible on screen for the current client.
UiAction.Description	setVisible(BooleanCondition visible) Set if the action's button is visible on screen for the current client.

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description()

Method Detail

getMethod

public String getMethod()

getId

public String getId()

getLabel

public String getLabel()

setLabel

public UiAction.Description setLabel(String label)

Set the label to appear on the button to activate this action.

getTitle

public String getTitle()

setTitle

public UiAction.Description setTitle(String title)

Set the tool-tip text to appear when the mouse hovers on the button.

isVisible

public boolean isVisible()

getVisibleCondition

public BooleanCondition getVisibleCondition()

setVisible

public UiAction.Description setVisible(boolean visible)

Set if the action's button is visible on screen for the current client. If not visible the action description may not be sent to the client.

setVisible

public UiAction.Description setVisible(BooleanCondition visible)

Set if the action's button is visible on screen for the current client. If not visible the action description may not be sent to the client.

isEnabled

public boolean isEnabled()

getEnabledCondition

public BooleanCondition getEnabledCondition()

setEnabled

public UiAction.Description setEnabled(boolean enabled)

Set if the button should be invokable (true), or greyed out (false).

setEnabled

public UiAction.Description setEnabled(BooleanCondition enabled)

Set if the button should be invokable (true), or greyed out (false).