Class ActionListPropertyDescriptor


public class ActionListPropertyDescriptor extends Install4JPropertyDescriptor
Property descriptor for properties that contain a list of configurable actions. The type of the property must by ActionList.

Using this class is not strictly required. In principle, you could also set values for the ATTRIBUTE_* constants in the property descriptor of an unrelated property descriptor class.

See Also:
  • Field Details

  • Method Details

    • create

      public static ActionListPropertyDescriptor create(String propertyName, Class beanClass, String displayName, String shortDescription)
      Create a property descriptor that can be passed to Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor).
      Parameters:
      propertyName - the name of the property
      beanClass - the class of the bean that contains the property. Note: This is not the class of the property.
      displayName - the display name of the property
      shortDescription - a short description of the property in HTML format. You do not have to start the description with <html>, it will be prepended automatically.
      Returns:
      the property descriptor
    • setAllowedActionClasses

      public ActionListPropertyDescriptor setAllowedActionClasses(Class[] actionClasses)
      If set to a non-null value, the action registry dialog will only display the specified actions. Derived classes are also shown, so you can include entire hierarchies with a single class. Otherwise all actions will be offered.
      Parameters:
      actionClasses - an array with the action classes
      Returns:
      this, for chained calls on this property descriptor
    • setExtraScriptParameters

      public ActionListPropertyDescriptor setExtraScriptParameters(ScriptParameter[] scriptParameters)
      If set to a non-null value, script properties of any actions contained in this action list will receive fixed extra script parameter of the defined type. The fixed parameters have to be passed to AbstractBean.executeActionListAsync(ActionList, Object...) or AbstractBean.executeActionListSync(ActionList, Object...) as the vararg parameter.
      Parameters:
      scriptParameters - the extra parameters
      Returns:
      this, for chained calls on this property descriptor
    • setConfigurableElevationType

      public ActionListPropertyDescriptor setConfigurableElevationType(boolean configurableElevationType)
      By default, the user can configure the elevation type of the nested actions. In that case, nested actions have an "Action elevation type" property that can be configured separately from the container.

      Sometimes it can be necessary to suppress this property, for example if the actions depend on non-serializable installer variables set by the container. To force a container action to be unelevated, you can call setDefaultActionElevationType(ActionElevationType.NONE, true) in the bean config of the action.

      Parameters:
      configurableElevationType - whether the action elevation type should be configurable
      Returns:
      this, for chained calls on this property descriptor
    • setActionKeys

      public ActionListPropertyDescriptor setActionKeys(String[] actionsKeys)
      Action keys can be used to show or hide properties of other actions. See Install4JPropertyDescriptor.setActionListShownKeys(String[]) and Install4JPropertyDescriptor.setActionListHiddenKeys(String[]) for more information.
      Parameters:
      actionsKeys - an array with the action keys
      Returns:
      this, for chained calls on this property descriptor