Package 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 Details

    • Description

      public Description()

  • Method Details

    • getMethod

      public String getMethod()

    • getId

      public String getId()

    • getLabel

      public String getLabel()

    • setLabel

      @CanIgnoreReturnValue public UiAction.Description setLabel(String label)
      Set the label to appear on the button to activate this action.

    • getTitle

      public String getTitle()

    • setTitle

      @CanIgnoreReturnValue 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

      @CanIgnoreReturnValue 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

      @CanIgnoreReturnValue 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

      @CanIgnoreReturnValue public UiAction.Description setEnabled(boolean enabled)
      Set if the button should be invokable (true), or greyed out (false).

    • setEnabled

      @CanIgnoreReturnValue public UiAction.Description setEnabled(BooleanCondition enabled)
      Set if the button should be invokable (true), or greyed out (false).

    • getEnabledOptions

      public com.google.common.collect.ImmutableList<String> getEnabledOptions()

    • setOption

      @CanIgnoreReturnValue public UiAction.Description setOption(String optionName, boolean enabled)