AGSPopupInfo Class Reference
Description
Instances of this class respresent popup definitions for features that need to be displayed in popups. Popup definitions contain information such as -
- Whether a user should be allowed to edit or delete the feature
- Which attributes of the feature should the popup display, whether they are editable, how to format numbers and dates, etc
- Whether the popup should show attachments for the feature
- What media, such as charts and images, should be displayed for the feature
- Since:
- 2.0
Public Member Functions | |
| (void) | - decodeWithJSON: |
| (NSDictionary *) | - encodeToJSON |
| (id) | - initWithJSON: |
Static Public Member Functions | |
| (AGSPopupInfo *) | + popupInfoForGraphic: |
Properties | |
| BOOL | allowDelete |
| BOOL | allowEdit |
| BOOL | allowEditGeometry |
| NSString * | description |
| NSArray * | fieldInfos |
| NSArray * | mediaInfos |
| BOOL | showAttachments |
| NSString * | title |
Member Function Documentation
| - (void) decodeWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Decode object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be decoded.
- Since:
- 1.0
| - (NSDictionary *) encodeToJSON | [optional, inherited] |
Encode and return JSON representation for object.
- Returns:
- JSON representation of object.
- Since:
- 1.0
| - (id) initWithJSON: | (NSDictionary *) | json | [optional, inherited] |
Initialize and return object from JSON representation.
- Parameters:
-
json The JSON representation of the object to be created.
- Returns:
- Object decoded from JSON representation.
- Since:
- 1.0
| + (AGSPopupInfo *) popupInfoForGraphic: | (AGSGraphic *) | graphic |
Returns an autoreleased default AGSPopupInfo for a given graphic.
- Parameters:
-
graphic If the graphic belongs to a feature layer, the constructor will consult the metadata on the feature layer and create a popup definition with appropriate defaults for fieldInfos. Otherwise, it will inspect the attributes of the graphic to create a basic popup definition which you can then programmatically modify.
- Returns:
- An autoreleased AGSPopupInfo
- Since:
- 2.0
Property Documentation
- (BOOL) allowDelete [read, write, assign] |
Whether or not the popup should allow the graphic to be deleted.
- Since:
- 2.0
- (BOOL) allowEdit [read, write, assign] |
Whether or not the popup should allow the graphic to be edited.
- Since:
- 2.0
- (BOOL) allowEditGeometry [read, write, assign] |
Whether or not the popup should allow the graphic's geometry should be edited. Only applicable when allowEdit is YES.
- Since:
- 2.0
- (NSString*) description [read, write, copy] |
The description that is shown for the graphic in the popup. This can be html. If description is nil then the fieldInfos are used when viewing attributes. This can contain a literal value, or a placeholder for value from the graphic's attribute. The placeholder needs to be of the form {field_name} where field_name is a key in the graphic's attributes.
- Since:
- 2.0
- (NSArray*) fieldInfos [read, write, retain] |
The graphic's fields that are displayed in the popup. If description is not nil then the fieldInfos are not used when viewing attributes.
- Since:
- 2.0
- (NSArray*) mediaInfos [read, write, retain] |
The media that is displayed in the popup.
- Since:
- 2.0
- (BOOL) showAttachments [read, write, assign] |
Whether or not the popup should show attachments of the graphic.
- Since:
- 2.0
- (NSString*) title [read, write, copy] |
The title that is displayed for the graphic in the popup. This can contain a literal value, or a placeholder for value from the graphic's attribute. The placeholder needs to be of the form {field_name} where field_name is a key in the graphic's attributes.
- Since:
- 2.0