public class EditorResourceStatus extends java.lang.Object implements ResourceStatus
Implementation of a ResourceStatus
for resources that are authored in the Editor
(such as pages or templates). EditorResourceStatus
es are retrieved and displayed in a
status bar in the Editor.
An EditorResourceStatus
consists of the following information:
ResourceStatus.getPriority()
)EditorResourceStatus.Variant
)getIcon()
)EditorResourceStatus.Action
)com.adobe.granite.resourcestatus
,
ResourceStatus
Modifier and Type | Class and Description |
---|---|
static class |
EditorResourceStatus.Action
Defines an action for an
EditorResourceStatus . |
static class |
EditorResourceStatus.Builder
Builder class to build
EditorResourceStatus instances. |
static class |
EditorResourceStatus.Variant
Defines the possible variants of statuses, in line with CoralUI.Alert variants.
|
Constructor and Description |
---|
EditorResourceStatus(java.lang.String type,
java.lang.String title,
java.lang.String message,
java.lang.Integer priority,
EditorResourceStatus.Variant variant,
java.lang.String icon,
java.util.List<EditorResourceStatus.Action> actions,
java.util.Map<java.lang.String,java.lang.Object> data)
Creates a status.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<EditorResourceStatus.Action> |
getActions()
Returns the actions of this status.
|
java.util.Map<java.lang.String,java.lang.Object> |
getAdditionalData()
Returns the additional data defined for this status, corresponding to the data that was
added using
EditorResourceStatus.Builder.addData(String, Object) . |
java.util.Map<java.lang.String,java.lang.Object> |
getData()
Returns an unmodifiable map containing the status information and data needed to render this
status.
|
java.lang.String |
getIcon()
Returns the name of a CoralUI icon to be displayed in the status.
|
java.lang.String |
getMessage()
Returns the status message.
|
int |
getPriority()
Returns the priority of this status corresponding to its importance
(
Integer.MAX_VALUE being the highest priority). |
java.lang.String |
getResourceSuperType()
Returns the resource super type to render this status.
|
java.lang.String |
getResourceType()
Returns the resource type to render this status.
|
java.lang.String |
getTitle()
Returns the title of this status, which describes the module or feature the status is
associated with.
|
java.lang.String |
getType()
Returns the type of this status defining the module or feature this status is associated
with.
|
EditorResourceStatus.Variant |
getVariant()
Returns the variant of this status.
|
public EditorResourceStatus(java.lang.String type, java.lang.String title, java.lang.String message, java.lang.Integer priority, EditorResourceStatus.Variant variant, java.lang.String icon, java.util.List<EditorResourceStatus.Action> actions, java.util.Map<java.lang.String,java.lang.Object> data)
type
- the status type (see ResourceStatus.getType()
)title
- the titlemessage
- the messagepriority
- the priority or null
variant
- the variant or null
icon
- the icon or null
actions
- a list of actions or null
data
- additional status data or null
EditorResourceStatus
public java.lang.String getType()
ResourceStatus
getType
in interface ResourceStatus
ResourceStatusProvider.getType()
public int getPriority()
ResourceStatus
Integer.MAX_VALUE
being the highest priority).getPriority
in interface ResourceStatus
public java.util.Map<java.lang.String,java.lang.Object> getData()
ResourceStatus
getData
in interface ResourceStatus
public java.lang.String getResourceType()
ResourceStatus
getResourceType
in interface ResourceStatus
null
public java.lang.String getResourceSuperType()
ResourceStatus
getResourceSuperType
in interface ResourceStatus
null
public java.lang.String getTitle()
getType()
), the title is
meant to be displayed in the user interface.public java.lang.String getMessage()
public EditorResourceStatus.Variant getVariant()
EditorResourceStatus.Variant
public java.lang.String getIcon()
EditorResourceStatus.Variant
).null
public java.util.Map<java.lang.String,java.lang.Object> getAdditionalData()
EditorResourceStatus.Builder.addData(String, Object)
. In contrast, getData()
returns
a map containing all information defining this status (i.e. including title,
message etc).public java.util.List<EditorResourceStatus.Action> getActions()
EditorResourceStatus.Action
"Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"