Package org.nuxeo.ecm.platform.actions
Class Action
java.lang.Object
org.nuxeo.ecm.platform.actions.Action
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Action>
Descriptor for action.
- Author:
- Bogdan Stefanescu
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected boolean
protected String[]
protected String
static final String[]
protected Boolean
protected boolean
protected ActionFilter[]
protected String
protected String
protected String
protected Boolean
protected String
protected String
protected Map<String,
Serializable> Extra set of properties to be used by API, when creating actions on the fly without contributions to the service.protected int
Attribute that provides a hint for action ordering.protected ActionPropertiesDescriptor
protected Map<String,
Serializable> protected String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
int
boolean
boolean
String[]
Returns the categories as a list.Returns the confirm javascript for this element.getHelp()
getIcon()
getId()
getLabel()
getLink()
Returns the link for this action.int
getOrder()
Returns the action order.Returns an aggregate oflocalProperties
andproperties
set via descriptors.protected String
getStringProperty
(String prop) getType()
int
hashCode()
boolean
boolean
Returns true if the enabled element was set on the descriptor, useful for merging.boolean
boolean
void
setAccessKey
(String accessKey) void
setAvailable
(boolean available) void
setCategories
(String[] categories) void
setConfirm
(String confirm) void
setEnabled
(boolean enabled) void
setFiltered
(boolean filtered) void
setFilterIds
(List<String> filterIds) void
setFilters
(ActionFilter[] filters) void
void
void
setImmediate
(boolean immediate) void
void
void
setOrder
(int order) Sets the order of the action.void
setProperties
(Map<String, Serializable> localProperties) Sets local properties programaticallyvoid
setPropertiesDescriptor
(ActionPropertiesDescriptor properties) void
toString()
-
Field Details
-
EMPTY_CATEGORIES
-
id
-
link
-
enabled
-
label
-
icon
-
confirm
-
help
-
immediate
-
accessKey
-
type
- Since:
- 5.6
-
properties
- Since:
- 5.6
-
localProperties
Extra set of properties to be used by API, when creating actions on the fly without contributions to the service.- Since:
- 5.6
-
propertiesCache
- Since:
- 5.6
-
available
protected boolean available -
filtered
protected boolean filtered- Since:
- 8.2
-
order
protected int orderAttribute that provides a hint for action ordering.:XXX: Action ordering remains a problem. We will continue to use the existing strategy of, by default, ordering actions by specificity of registration and order of definition.
-
categories
-
filterIds
-
filters
-
-
Constructor Details
-
Action
public Action() -
Action
-
-
Method Details
-
isEnableSet
public boolean isEnableSet()Returns true if the enabled element was set on the descriptor, useful for merging.- Since:
- 5.8
-
isEnabled
public boolean isEnabled() -
setEnabled
public void setEnabled(boolean enabled) -
getStringProperty
-
getLabel
-
setLabel
-
getIcon
-
setIcon
-
getLink
Returns the link for this action.Since 5.7.3, fallbacks on properties when link is not set and retrieve it using key "link".
-
setLink
-
getCategories
-
getCategoryList
Returns the categories as a list.- Since:
- 7.2
-
getId
-
toString
-
getOrder
public int getOrder()Returns the action order.- Returns:
- the action order as an integer value
-
setOrder
public void setOrder(int order) Sets the order of the action.- Parameters:
order
- order of the action
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Action>
-
getFilterIds
-
setFilterIds
-
getFilters
-
setFilters
-
setCategories
-
getConfirm
Returns the confirm javascript for this element.Since 5.7.3, fallbacks on properties when link is not set and retrieve it using key "confirm".
-
setConfirm
-
getAvailable
public boolean getAvailable() -
setAvailable
public void setAvailable(boolean available) -
isFiltered
public boolean isFiltered()- Since:
- 8.2
-
setFiltered
public void setFiltered(boolean filtered) - Since:
- 8.2
-
getHelp
-
setHelp
-
isImmediate
public boolean isImmediate() -
setImmediate
public void setImmediate(boolean immediate) -
getType
- Since:
- 5.6
-
setType
- Since:
- 5.6
-
getPropertiesDescriptor
- Since:
- 5.6
-
setPropertiesDescriptor
- Since:
- 5.6
-
setProperties
Sets local properties programatically- Since:
- 5.6
-
getProperties
Returns an aggregate oflocalProperties
andproperties
set via descriptors.- Since:
- 5.6
-
setAccessKey
- Since:
- 5.6
-
getAccessKey
- Since:
- 5.6
-
equals
-
hashCode
public int hashCode() -
clone
-