| java.lang.Object | |
| ↳ | com.esri.core.symbol.advanced.MessageHelper |
Class Overview
Helper class which provides user-friendly property names and convenient methods to create message.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME | The Constant MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME. | |||||||||
| String | MESSAGE_ACTION_PROPERTY_NAME | The Constant MESSAGE_ACTION_PROPERTY_NAME. | |||||||||
| String | MESSAGE_ACTION_VALUE_HIGHLIGHT | The Constant MESSAGE_ACTION_VALUE_HIGHLIGHT. | |||||||||
| String | MESSAGE_ACTION_VALUE_REMOVE | The Constant MESSAGE_ACTION_VALUE_REMOVE. | |||||||||
| String | MESSAGE_ACTION_VALUE_UNHIGHLIGHT | The Constant MESSAGE_ACTION_VALUE_HIGHLIGHT. | |||||||||
| String | MESSAGE_ACTION_VALUE_UPDATE | The Constant MESSAGE_ACTION_VALUE_UPDATE. | |||||||||
| String | MESSAGE_ID_PROPERTY_NAME | The Constant MESSAGE_ID_PROPERTY_NAME. | |||||||||
| String | MESSAGE_TYPE_PROPERTY_NAME | The Constant MESSAGE_TYPE_PROPERTY_NAME. | |||||||||
| String | MESSAGE_WKID_PROPERTY_NAME | The Constant MESSAGE_WKID_PROPERTY_NAME. | |||||||||
| String | MESSAGE_WKT_PROPERTY_NAME | The Constant MESSAGE_WKT_PROPERTY_NAME. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| MessageHelper() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static Message |
create2525CHighlightMessage(String ID, String messageType, boolean highlight)
Creates a 2525C message to highlight/un-highlight the symbol.
| ||||||||||
| static Message |
create2525CRemoveMessage(String ID, String messageType)
Creates a 2525C message to remove the symbol.
| ||||||||||
| static Message |
create2525CUpdateMessage(String ID, Map<String, Object> attributes)
Creates a 2525C message to update the symbol with specified properties.
| ||||||||||
| static Message |
create2525CUpdateMessage(String ID, String propertyName, Object propertyValue)
Creates a 2525C message to update the symbol with specified property name and value.
| ||||||||||
| static Message |
create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes, String WKT)
Creates a 2525C message to create or update the symbol.
| ||||||||||
| static Message |
create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes)
Creates a 2525C message to update the symbol.
| ||||||||||
| static Message |
create2525CUpdateMessage(String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes, int WKID)
Creates a 2525C message to create or update the symbol.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME
The Constant MESSAGE_2525C_CONTROL_POINTS_PROPERTY_NAME.
Constant Value:
"_Control_Points"
public static final String MESSAGE_ACTION_PROPERTY_NAME
The Constant MESSAGE_ACTION_PROPERTY_NAME.
Constant Value:
"_Action"
public static final String MESSAGE_ACTION_VALUE_HIGHLIGHT
The Constant MESSAGE_ACTION_VALUE_HIGHLIGHT.
Constant Value:
"select"
public static final String MESSAGE_ACTION_VALUE_REMOVE
The Constant MESSAGE_ACTION_VALUE_REMOVE.
Constant Value:
"remove"
public static final String MESSAGE_ACTION_VALUE_UNHIGHLIGHT
The Constant MESSAGE_ACTION_VALUE_HIGHLIGHT.
Constant Value:
"un-select"
public static final String MESSAGE_ACTION_VALUE_UPDATE
The Constant MESSAGE_ACTION_VALUE_UPDATE.
Constant Value:
"update"
public static final String MESSAGE_ID_PROPERTY_NAME
The Constant MESSAGE_ID_PROPERTY_NAME.
Constant Value:
"_ID"
public static final String MESSAGE_TYPE_PROPERTY_NAME
The Constant MESSAGE_TYPE_PROPERTY_NAME.
Constant Value:
"_Type"
public static final String MESSAGE_WKID_PROPERTY_NAME
The Constant MESSAGE_WKID_PROPERTY_NAME.
Constant Value:
"_WKID"
public static final String MESSAGE_WKT_PROPERTY_NAME
The Constant MESSAGE_WKT_PROPERTY_NAME.
Constant Value:
"_WKT"
Public Constructors
public MessageHelper ()
Public Methods
public static Message create2525CHighlightMessage (String ID, String messageType, boolean highlight)
Creates a 2525C message to highlight/un-highlight the symbol.
Parameters
| ID | messageID. |
|---|---|
| messageType | message type. |
| highlight | true to highlight, otherwise un-highlight. |
Returns
- a Message object.
public static Message create2525CRemoveMessage (String ID, String messageType)
Creates a 2525C message to remove the symbol.
Parameters
| ID | message ID. |
|---|---|
| messageType | message type. |
Returns
- a Message object.
public static Message create2525CUpdateMessage (String ID, Map<String, Object> attributes)
Creates a 2525C message to update the symbol with specified properties.
Parameters
| ID | message ID. |
|---|---|
| attributes | attributes as a map. |
Returns
- a Message object.
public static Message create2525CUpdateMessage (String ID, String propertyName, Object propertyValue)
Creates a 2525C message to update the symbol with specified property name and value. It is assumed that a symbol has been created with the same ID when this method is used.
Parameters
| ID | message ID. |
|---|---|
| propertyName | name of the property to update. |
| propertyValue | value of the property to update. |
Returns
- a Message object.
public static Message create2525CUpdateMessage (String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes, String WKT)
Creates a 2525C message to create or update the symbol. This method is useful for a message aiming to display the symbol very first time.
Parameters
| ID | message ID. |
|---|---|
| messageType | message type as defined in the message type file. |
| controlPoints | control points. |
| attributes | attributes as a map. |
| WKT | well-known text of the spatial reference. |
Returns
- a Message object.
public static Message create2525CUpdateMessage (String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes)
Creates a 2525C message to update the symbol.
Parameters
| ID | message ID. |
|---|---|
| messageType | message type. |
| controlPoints | control points. |
| attributes | attributes map |
Returns
- a Message object.
public static Message create2525CUpdateMessage (String ID, String messageType, List<Point> controlPoints, Map<String, Object> attributes, int WKID)
Creates a 2525C message to create or update the symbol. This method is useful for a message aiming to display the symbol very first time.
Parameters
| ID | message ID |
|---|---|
| messageType | message type as defined in the message type file. |
| controlPoints | control points. |
| attributes | attributes as a map |
| WKID | well-known ID of the spatial reference. |
Returns
- a Message object.