public class ActionListPropertyDescriptor extends Install4JPropertyDescriptor
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.
ActionList
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTION_KEY_NO_ROLLBACK
Action key for properties of type
ActionList that do not support rollback. |
static java.lang.String |
ATTRIBUTE_ACTION_KEYS |
static java.lang.String |
ATTRIBUTE_ALLOWED_ACTION_CLASSES |
static java.lang.String |
ATTRIBUTE_CONFIGURABLE_ELEVATION_TYPE |
static java.lang.String |
ATTRIBUTE_EXTRA_SCRIPT_PARAMETERS |
ATTRIBUTE_ACTION_LIST_HIDDEN_KEYS, ATTRIBUTE_ACTION_LIST_SHOWN_KEYS, ATTRIBUTE_CONTEXT, ATTRIBUTE_PARENT_PROPERTY, ATTRIBUTE_PROPERTY_CATEGORY, ATTRIBUTE_PROPERTY_CHANGE_LISTENER, ATTRIBUTE_SORT_KEY, ATTRIBUTE_VARIABLE_VALUE_CLASS, ATTRIBUTE_VISIBILITY_DISCRIMINATOR, CATEGORY_CONFIGURATION, CONTEXT_ANCHOR_CORNERS, CONTEXT_ANCHOR_HORIZONTAL, CONTEXT_ANCHOR_SIDES, CONTEXT_ANCHOR_VERTICAL, CONTEXT_COMPONENT_ID, CONTEXT_DATETIME, CONTEXT_DOWNLOADABLE_COMPONENT_ID, CONTEXT_FORM_COMPONENT_ID, CONTEXT_HTML, CONTEXT_LAUNCHER_ID, CONTEXT_MULTILINE, CONTEXT_NO_INSTALLER_VARIABLES, CONTEXT_NON_SERVICE_LAUNCHER_ID, CONTEXT_SERVICE_LAUNCHER_ID, CONTEXT_STRING_TO_STRING_MAP, CONTEXT_STYLE_ID, CONTEXT_VARIABLE_NAME
Modifier and Type | Method and Description |
---|---|
static ActionListPropertyDescriptor |
create(java.lang.String propertyName,
java.lang.Class beanClass,
java.lang.String displayName,
java.lang.String shortDescription)
Create a property descriptor that can be passed to
Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor) . |
ActionListPropertyDescriptor |
setActionKeys(java.lang.String[] actionsKeys)
Action keys can be used to show or hide properties of other actions.
|
ActionListPropertyDescriptor |
setAllowedActionClasses(java.lang.Class[] actionClasses)
If set to a non-null value, the action registry dialog will only display the specified actions.
|
ActionListPropertyDescriptor |
setConfigurableElevationType(boolean configurableElevationType)
By default, the user can configure the elevation type of the nested actions.
|
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.
|
create, setActionListHiddenKeys, setActionListShownKeys, setContext, setDisplayName, setHiddenInActionLists, setParentProperty, setPropertyCategory, setPropertyChangeListener, setSortKey, setVariableValueClass, setVisibilityDiscriminator
createPropertyEditor, equals, getPropertyEditorClass, getPropertyType, getReadMethod, getWriteMethod, hashCode, isBound, isConstrained, setBound, setConstrained, setPropertyEditorClass, setReadMethod, setWriteMethod
public static final java.lang.String ATTRIBUTE_ALLOWED_ACTION_CLASSES
public static final java.lang.String ATTRIBUTE_EXTRA_SCRIPT_PARAMETERS
public static final java.lang.String ATTRIBUTE_CONFIGURABLE_ELEVATION_TYPE
(boolean)
,
Constant Field Valuespublic static final java.lang.String ATTRIBUTE_ACTION_KEYS
public static final java.lang.String ACTION_KEY_NO_ROLLBACK
ActionList
that do not support rollback.
Properties in standard actions that deal with rollback are not shown in the install4j IDE in that case.
Call setActionKeys(String[])
with an array that contains this string to select this behavior for
an action list property.
public static ActionListPropertyDescriptor create(java.lang.String propertyName, java.lang.Class beanClass, java.lang.String displayName, java.lang.String shortDescription)
Install4JBeanInfo.addPropertyDescriptor(Install4JPropertyDescriptor)
.propertyName
- the name of the propertybeanClass
- the class of the bean that contains the property. Note: This is not the class of the property.displayName
- the display name of the propertyshortDescription
- a short description of the property in HTML format. You do not have to start the description with <html>, it will be prepended automatically.public ActionListPropertyDescriptor setAllowedActionClasses(java.lang.Class[] actionClasses)
actionClasses
- an array with the action classesthis
, for chained calls on this property descriptorpublic ActionListPropertyDescriptor setExtraScriptParameters(ScriptParameter[] scriptParameters)
AbstractBean.executeActionListAsync(ActionList, Object...)
or
AbstractBean.executeActionListSync(ActionList, Object...)
as the
vararg parameter.scriptParameters
- the extra parametersthis
, for chained calls on this property descriptorpublic ActionListPropertyDescriptor setConfigurableElevationType(boolean configurableElevationType)
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.
configurableElevationType
- whether the action elevation type should be configurablethis
, for chained calls on this property descriptorpublic ActionListPropertyDescriptor setActionKeys(java.lang.String[] actionsKeys)
Install4JPropertyDescriptor.setActionListShownKeys(String[])
and
Install4JPropertyDescriptor.setActionListHiddenKeys(String[])
for more information.actionsKeys
- an array with the action keysthis
, for chained calls on this property descriptor