Package org.csstudio.opibuilder.widgetActions

Class AbstractWidgetAction

java.lang.Object
org.csstudio.opibuilder.widgetActions.AbstractWidgetAction
All Implemented Interfaces:
IAdaptable
Direct Known Subclasses:
AbstractExecuteScriptAction, ExecuteCommandAction, OpenDisplayAction, OpenFileAction, OpenWebpageAction, PlayWavFileAction, RunCommandAction, RunCommandStackAction, RunProcedureAction, WritePVAction
public abstract class AbstractWidgetAction extends Object implements IAdaptable
The abstract widget action, which can be executed from the widget by click or context menu.

  • Field Details

  • Constructor Details

    • AbstractWidgetAction

      public AbstractWidgetAction()

  • Method Details

    • addProperty

      public void addProperty(AbstractWidgetProperty<?> property)
      Add a property to the widget.
      Parameters:
      property - the property to be added.

    • configureProperties

      protected abstract void configureProperties()

    • getDefaultDescription

      public String getDefaultDescription()

    • getDescription

      public String getDescription()

    • run

      public abstract void run()

    • getActionType

      public abstract WidgetActionFactory.ActionType getActionType()

    • getAllProperties

      public AbstractWidgetProperty<?>[] getAllProperties()

    • getPropertyValue

      public Object getPropertyValue(Object id)

    • setPropertyValue

      public void setPropertyValue(Object id, Object value)

    • getAdapter

      public <T> T getAdapter(Class<T> adapter)
      Specified by:
      getAdapter in interface IAdaptable

    • getCopy

      public AbstractWidgetAction getCopy()

    • getAllPropertyIDs

      public Set<String> getAllPropertyIDs()

    • getProperty

      public AbstractWidgetProperty<?> getProperty(String propId)

    • setEnabled

      public void setEnabled(boolean enabled)
      Parameters:
      enabled - the enabled to set

    • isEnabled

      public boolean isEnabled()
      Returns:
      the enabled

    • setWidgetModel

      public void setWidgetModel(AbstractWidgetModel widgetModel)
      Parameters:
      widgetModel - the widgetModel to set

    • getWidgetModel

      public AbstractWidgetModel getWidgetModel()
      Returns:
      the widgetModel

    • dispose

      public void dispose()
      Dispose of all resources allocated by this action.