AGSPopupManager.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <ArcGIS/AGSDefines.h>
#import <ArcGIS/AGSField.h>
#import <ArcGIS/AGSCancelable.h>
 
 
 
AGS_EXTERN NSString *const AGSPopupValidationErrorDomain;
 
typedef NS_ENUM(NSInteger, AGSPopupFeatureTypeChangeMode) {
    AGSPopupFeatureTypeChangeModeResetDefaultValues = 0,    
    AGSPopupFeatureTypeChangeModeKeepValues = 1             
};
 
typedef NS_ENUM(NSInteger, AGSPopupValidationErrorCode) {
    AGSPopupValidationErrorCodeInvalidGeoElement = 11000,   
    AGSPopupValidationErrorCodeNullNotAllowed = 11001,      
    AGSPopupValidationErrorCodeValueOutOfRange = 11002,     
    AGSPopupValidationErrorExceedsMaxLength = 11003,        
    AGSPopupValidationErrorInvalidNumericString = 11004,    
    AGSPopupValidationErrorExceedsNumericMaximum = 11005,   
    AGSPopupValidationErrorLessThanNumericMinimum = 11006,  
    AGSPopupValidationErrorIllegalDomainCode = 11007,       
    AGSPopupValidationErrorContingencyValidationFailure = 11008        
};
 
@class AGSPopupAttachmentManager;
@class AGSPopupField;
@class AGSPopup;
@class AGSFeatureType;
@class AGSDomain;
@class AGSFeatureTemplate;
@class AGSSymbol;
@class AGSSketchEditor;
@class AGSPopupExpressionEvaluation;
@class AGSContingentValuesResult;
@class AGSPopupElement;
 
@protocol AGSPopupManagerDelegate;
 
#pragma mark -
#pragma mark Notifications / (Events)
#pragma mark -
 
AGS_EXTERN NSNotificationName _Nonnull const AGSPopupManagerGeoElementValidityDidChangeNotification;
 
AGS_EXTERN NSNotificationName _Nonnull const AGSPopupManagerFeatureTypeDidChangeNotification;
 
AGS_EXTERN NSNotificationName _Nonnull const AGSPopupManagerGeoElementWarningsDidChangeNotification;
 
AGS_EXTERN NSNotificationName _Nonnull const AGSPopupManagerGeoElementContingencyValidationErrorsDidChangeNotification;
 
AGS_EXTERN NSNotificationName _Nonnull const AGSPopupManagerGeoElementContingencyValidationWarningsDidChangeNotification;
 
@interface AGSPopupManager : NSObject
 
#pragma mark -
#pragma mark initializers
#pragma mark -
 
 
-(instancetype)initWithPopup:(AGSPopup *)popup;
 
 
#pragma mark -
#pragma mark properties
#pragma mark -
 
@property (nullable, nonatomic, weak, readwrite) id<AGSPopupManagerDelegate> delegate;
 
@property (nonatomic, unsafe_unretained, readonly) AGSPopup *popup;
 
@property (nullable, nonatomic, strong, readonly) AGSPopupAttachmentManager *attachmentManager;
 
@property (nonatomic, copy, readonly) NSArray<AGSPopupElement *> *evaluatedElements;
 
 
#pragma mark display properties
 
 
@property (nullable, nonatomic, strong, readonly) AGSFeatureType *featureType;
 
@property (nonatomic, copy, readonly) NSArray<AGSPopupField*> *editableDisplayFields;
 
@property (nonatomic, copy, readonly) NSArray<AGSPopupField*> *displayFields;
 
 
#pragma mark Strings that the popup view controller will use in the UI
 
 
@property (nullable, nonatomic, copy, readonly) NSString *title;
 
@property (nullable, nonatomic, copy, readonly) NSString *customDescriptionHTML;
 
@property (nullable, nonatomic, copy, readonly) NSString *editSummary;
 
@property (nullable, nonatomic, strong, readonly) AGSSymbol *symbol;
 
#pragma mark Properties for what UI the popup view controller should show
 
 
@property (nonatomic, assign, readonly) BOOL shouldAllowEdit;
 
@property (nonatomic, assign, readonly) BOOL shouldAllowDelete;
 
@property (nonatomic, assign, readonly) BOOL shouldAllowEditGeometry;
 
@property (nonatomic, assign, readonly) BOOL shouldAllowEditAttachments;
 
@property (nonatomic, assign, readonly) BOOL shouldShowAttachments;
 
@property (nonatomic, assign, readonly) BOOL shouldShowMedia;
 
@property (nonatomic, assign, readonly) BOOL shouldShowEditSummary;
 
@property (nonatomic, assign, readonly) BOOL shouldShowCustomDescriptionHTML;
 
#pragma mark editing properties
 
@property (nonatomic, assign, readonly, getter=isEditing) BOOL editing;
 
@property (nullable, nonatomic, strong, readonly) AGSSketchEditor *currentSketchEditor;
 
@property (nonatomic, assign, readonly, getter=isGeoElementValid) BOOL geoElementValid;
 
 
@property (nonatomic, copy, readonly) NSDictionary<NSString *, NSError *> *contingencyValidationErrors;
 
@property (nonatomic, copy, readonly) NSDictionary<NSString *, NSError *> *contingencyValidationWarnings;
 
#pragma mark -
#pragma mark methods
#pragma mark -
 
 
#pragma mark Value Helper Methods
 
-(nullable NSString*)stringForTemplatedString:(NSString*)templatedString;
 
-(nullable NSNumber*)numberFromString:(NSString*)stringValue field:(AGSPopupField*)popupField ;
 
-(nullable NSNumber*)numberFromString:(NSString *)stringValue field:(AGSPopupField *)popupField error:(NSError**)error;
 
-(NSString*)formattedValueForField:(AGSPopupField*)popupField;
 
-(nullable id)valueForField:(AGSPopupField*)popupField;
 
- (nullable id)valueForFieldName:(NSString *)fieldName
                    popupElement:(AGSPopupElement *)popupElement;
 
#pragma mark Field Helper Methods
 
 
-(nullable AGSPopupField*)fieldForName:(NSString*)fieldName;
 
-(AGSFieldType)fieldTypeForField:(AGSPopupField*)popupField;
 
-(nullable AGSDomain*)domainForField:(AGSPopupField*)popupField;
 
-(NSInteger)lengthForField:(AGSPopupField*)popupField;
 
-(BOOL)fieldIsNullable:(AGSPopupField*)popupField;
 
-(BOOL)fieldIsTypeIDField:(AGSPopupField*)popupField;
 
-(NSString *)labelForField:(AGSPopupField *)popupField;
 
#pragma mark Contingent Value Helper Methods
 
- (BOOL)isFieldInFieldGroup:(AGSPopupField *)popupField;
 
- (nullable AGSContingentValuesResult *)contingentValuesResultForField:(AGSPopupField *)popupField;
 
#pragma mark Async Methods
 
- (id<AGSCancelable>)evaluateExpressionsWithCompletion:(void(^)(NSArray<AGSPopupExpressionEvaluation *> * __nullable results, NSError * __nullable error))completion;
 
#pragma mark -
#pragma mark Editing Methods
#pragma mark -
 
 
#pragma mark methods for starting, cancelling, finishing editing
 
 
-(BOOL)startEditing;
 
-(void)cancelEditing;
 
-(void)finishEditingWithCompletion:(void(^)(NSError * __nullable error))completion;
 
 
#pragma mark methods for updating the value in the geoelement when user changes values
 
-(BOOL)updateValue:(nullable id)newValue field:(AGSPopupField*)popupField validationError:(NSError**)validationError;
 
-(BOOL)featureTypeChangeRequiresUserNoficationForTemplate:(nullable AGSFeatureTemplate*)featureTemplate  ;
 
-(BOOL)featureTypeChangeRequiresUserNotificationForTemplate:(nullable AGSFeatureTemplate*)featureTemplate;
 
-(BOOL)updateFeatureTypeWithTemplate:(nullable AGSFeatureTemplate*)featureTemplate changeMode:(AGSPopupFeatureTypeChangeMode)changeMode validationError:(NSError**)validationError;
 
 
#pragma mark methods for getting validation errors and messages
 
 
-(nullable NSError*)validationErrorForField:(AGSPopupField*)popupField;
 
-(nullable NSError*)validationWarningForField:(AGSPopupField*)popupField;
 
-(nullable NSString*)rangeValidationTextForField:(AGSPopupField*)popupField;
 
@end
 
@protocol AGSPopupManagerDelegate 
@optional
 
-(nullable AGSSketchEditor*)sketchEditorForPopupManager:(AGSPopupManager*)popupManager;
 
-(void)popupManager:(AGSPopupManager*)popupManager validityDidChange:(BOOL)geoElementValid;
 
-(void)popupManager:(AGSPopupManager*)popupManager featureTypeDidChange:(nullable AGSFeatureType*)featureType;
 
@end