AGSPopup Class Reference


Description

Instances of this class represent a popup which associates a graphic with popup definition for the purpose of displaying in an AGSPopupsContainer.

Since:
2.0

List of all members.

Public Member Functions

(id) - initWithGraphic:popupInfo:

Static Public Member Functions

(AGSPopup *) + popupWithGraphic:popupInfo:

Properties

BOOL allowDelete
BOOL allowEdit
BOOL allowEditGeometry
AGSFeatureLayerfeatureLayer
AGSGraphicgraphic
AGSPopupInfopopupInfo

Member Function Documentation

- (id) initWithGraphic: (AGSGraphic *)  graphic
popupInfo: (AGSPopupInfo *)  popupInfo 

Initializes an AGSPopup instance.

Parameters:
graphic for which the popup needs to be displayed
popupInfo defining how information about the graphic should be displayed
Returns:
An AGSPopup
Since:
2.0
+ (AGSPopup*) popupWithGraphic: (AGSGraphic *)  graphic
popupInfo: (AGSPopupInfo *)  popupInfo 

Returns an autoreleased AGSPopup.

Parameters:
graphic for which the popup needs to be displayed
popupInfo defining how information about the graphic should be displayed
Returns:
An autoreleased AGSPopup
Since:
2.0

Property Documentation

- (BOOL) allowDelete [read, write, assign]

Whether or not the popup should allow the graphic to be deleted.

Since:
2.3
- (BOOL) allowEdit [read, write, assign]

Whether or not the popup should allow the graphic to be edited.

Since:
2.3
- (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.3
- (AGSFeatureLayer*) featureLayer [read, retain]

A convenient way to retrieve the feature layer for the popup graphic. Will be nil if the graphic was not part of a feature layer when the popup was initialized. This is helpful if you have popups open for graphics in an OnDemand feature layer that is refreshing and the graphics are getting removed from the feature layer. This will cache the feature layer, at the time of initialization so that you can post edits, etc, on this reference.

Since:
2.1
- (AGSGraphic*) graphic [read, retain]

The graphic whose details need to be displayed in the popup.

Since:
2.0
- (AGSPopupInfo*) popupInfo [read, retain]

A popup definition that dictates which information belonging to the graphic should be displayed in the popup and how it should be formatted.

Since:
2.0