AGSPopupsContainerViewController Class Reference

---

Description

Instances of this class represent a view controller that provides the basic user interface (UI) and behavior for displaying and editing information about graphics in a popup. It is a container and manages a number of view controllers behind the scenes, each of which is designed for a specific purpose, such as editing an attribute, displaying media, managing attachments, etc. It manages transitions between these view controllers and displays the relevant one depending upon what the user intends to do.

See also:

Conceptual Doc: Working With Web Map Popups

Sample: Feature Layer Editing

Since:

2.0

Inheritance diagram for AGSPopupsContainerViewController:

List of all members.

Public Member Functions
(UIBarButtonItem *customActionButton)	- __attribute__
(void)	- clearAllPopups
(id)	- initWithPopupInfo:graphic:usingNavigationControllerStack:
(id)	- initWithPopups:
(id)	- initWithPopups:usingNavigationControllerStack:
(id)	- initWithWebMap:forFeature:usingNavigationControllerStack:
(void)	- showAdditionalPopups:
(void)	- startEditingCurrentPopup
Properties
UIBarButtonItem *	actionButton
UIView *	actionSheetContainerView
AGSGeometry *	currentEditingGeometry
AGSPopup *	currentPopup
UIBarButtonItem *	defaultActionButton
UIBarButtonItem *	defaultDoneButton
id< AGSPopupsContainerDelegate >	delegate
UIBarButtonItem *	doneButton
AGSPopupsContainerEditingStyle	editingStyle
BOOL	inEditingMode
UIViewController *	modalPresenter
AGSPopupsContainerPagingStyle	pagingStyle
NSArray *	popups
AGSPopupsContainerStyle	style
UIColor *	styleColor

---

Member Function Documentation

- (UIBarButtonItem* customActionButton) __attribute__

((deprecated))

You can replace the button that appears on the right side of the Navigation Bar with a custom button through this property.

Since:

2.0

Deprecated:

Deprecated at 2.1. Please use actionButton instead.

Reimplemented from <AGSPopupsContainer>.

- (void) clearAllPopups

Clears all the popups currently being shown. This is useful if you want to reuse an existing popups container to display an entirely new set of popups. That way, the popups container doesn't have to reload from a NIB everytime it is shown.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (id) initWithPopupInfo:		(AGSPopupInfo *)	popupInfo
graphic:		(AGSGraphic *)	graphic
usingNavigationControllerStack:		(BOOL)	usingNavigationControllerStack

Initializes an AGSPopupsContainerViewController with an AGSPopupInfo and an AGSGraphic. The feature must belong to the graphics collection of an AGSFeatureLayer.

Parameters:

	popupInfo	representing the popup definition
	graphic	for which to display the popup
	usingNavigationControllerStack	A boolean indicating whether the navigation controller in the application should be updated when displaying popups

Since:

2.0

- (id) initWithPopups:

(NSArray *)

popups

Initializes an AGSPopupsContainerViewController.

Parameters:

popups

An array of AGSPopup objects representing the popups to be displayed

Since:

2.0

- (id) initWithPopups:		(NSArray *)	popups
usingNavigationControllerStack:		(BOOL)	usingNavigationControllerStack

Initializes an AGSPopupsContainerViewController.

Parameters:

	popups	An array of AGSPopup objects representing the popups to be displayed
	usingNavigationControllerStack	A boolean indicating whether the navigation controller in the application should be updated when displaying popups

Since:

2.0

- (id) initWithWebMap:		(AGSWebMap *)	webmap
forFeature:		(AGSGraphic *)	feature
usingNavigationControllerStack:		(BOOL)	usingNavigationControllerStack

Initializes an AGSPopupsContainerViewController with an AGSWebMap and an AGSGraphic. The feature must belong to the graphics collection of an AGSFeatureLayer.

Parameters:

	webmap	containing the popup definition
	feature	for which to display the popup
	usingNavigationControllerStack	A boolean indicating whether the navigation controller in the application should be updated when displaying popups

Since:

2.0

- (void) showAdditionalPopups:

(NSArray *)

popupInfos

Update the view controller to display additional popups. This is useful when the view controller is already displaying some popups, but you then want to display additional popups that were retrieved in the background, for example, as part of a query/identify operation.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (void) startEditingCurrentPopup

Start the editing process for the currently shown popup.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

---

Property Documentation

- (UIBarButtonItem*) actionButton [read, write, retain]

You can replace the button that appears on the right side of the Navigation Bar with a custom button through this property.

Since:

2.1

Reimplemented from <AGSPopupsContainer>.

- (UIView*) actionSheetContainerView [read, write, assign]

The UIView that will act as a container for any UIActionSheet.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (AGSGeometry*) currentEditingGeometry [read, retain]

When in edit mode and geometry editing is allowed, this property returns a mutable geometry that you can edit and when editing is finished, it will be set on the current popup's graphic.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (AGSPopup*) currentPopup [read, retain]

The current popup that is being viewed.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (UIBarButtonItem*) defaultActionButton [read, retain]

The default action button that is shown.

Since:

2.1

Reimplemented from <AGSPopupsContainer>.

- (UIBarButtonItem*) defaultDoneButton [read, retain]

The default done button that is shown.

Since:

2.1

Reimplemented from <AGSPopupsContainer>.

- (id<AGSPopupsContainerDelegate>) delegate [read, write, assign]

The delegate to be notified when a user interacts with the popups or edits graphics related to the popups. The delegate class must adopt the AGSPopupsContainerDelegate protocol.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (UIBarButtonItem*) doneButton [read, write, retain]

You can replace the button that appears on the left side of the Navigation Bar with a custom button through this property.

Since:

2.1

Reimplemented from <AGSPopupsContainer>.

- (AGSPopupsContainerEditingStyle) editingStyle [read, write, assign]

The style that is used for editing.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (BOOL) inEditingMode [read, assign]

Indicates whether the view controller is in the process of editing a feature.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (UIViewController*) modalPresenter [read, write, retain]

The UIViewController that should be used for presenting modal view controllers from within this AGSPopupsContainer. This is useful when using this view controller as a standalone object (for example, in a custom callout or a custom view) and when it's not part of a view controller hierarchy.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (AGSPopupsContainerPagingStyle) pagingStyle [read, write, assign]

The style that is used for paging when multiple popups are being displayed.

Since:

2.0

- (NSArray*) popups [read, write, retain]

The popups to be displayed.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (AGSPopupsContainerStyle) style [read, write, assign]

The style for the AGSPopupsContainer.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.

- (UIColor*) styleColor [read, write, retain]

The UIColor that is used for the toolbars in the popup views when style is set to AGSPopupsContainerStyleCustomColor.

Since:

2.0

Reimplemented from <AGSPopupsContainer>.