Inherits from NSObject
Declared in AdobeImageEditorCustomization.h

Overview

This class provides a powerful interface for configuring AdobeUXImageEditorViewController’s appearance and behavior. While changing values after presenting an AdobeUXImageEditorViewController’s instance is possible, it is strongly recommended that you make all necessary calls to AdobeImageEditorCustomization before editor presentation. Example usage can be found in the iOS SDK Customization Guide.

Class Methods

disableLocalization:

Configures the editor to use localization or not.

+ (void)disableLocalization:(BOOL)disableLocalization

Parameters

disableLocalization

YES disables localization, NO leaves it enabled.

Discussion

Configures the editor to use localization or not.

By default, Aviary enables localization.

Declared In

AdobeImageEditorCustomization.h

purgeGPUMemoryWhenPossible:

Configures the editor to free GPU memory when possible.

+ (void)purgeGPUMemoryWhenPossible:(BOOL)purgeGPUMemory

Parameters

purgeGPUMemory

YES purges GPU memory when possible, NO retains it.

Discussion

Configures the editor to free GPU memory when possible.

By default, the SDK keeps a small number of OpenGL objects loaded to optimize launches of the editor. Set this key to YES purge GPU memory when possible.

Declared In

AdobeImageEditorCustomization.h

setConfirmOnCancelEnabled:

Configures whether to ask the user for a confirmation when cancelling out of the editor with unsaved edits.

+ (void)setConfirmOnCancelEnabled:(BOOL)confirmOnCancelEnabled

Parameters

tutorialsEnabled

whether to show the confirmation or not

Discussion

Configures whether to ask the user for a confirmation when cancelling out of the editor with unsaved edits.

By default, this returns YES.

Declared In

AdobeImageEditorCustomization.h

setCropToolCustomEnabled:

Enables or disables the custom crop size.

+ (void)setCropToolCustomEnabled:(BOOL)cropToolEnableCustom

Parameters

cropToolEnableCustom

YES enables the custom crop size, NO disables it.

Discussion

Enables or disables the custom crop size.

The Custom crop preset does not constrain the crop area to any specific aspect ratio. By default, custom crop size is enabled.

Declared In

AdobeImageEditorCustomization.h

setCropToolInvertEnabled:

Enables or disables the invertability of crop sizes.

+ (void)setCropToolInvertEnabled:(BOOL)cropToolEnableInvert

Parameters

cropToolEnableInvert

YES enables the crop size inversion, NO disables it.

Discussion

Enables or disables the invertability of crop sizes.

By default, inversion is enabled. Presets with names, i.e. Square, are not invertible, regardless of whether inversion is enabled.

Declared In

AdobeImageEditorCustomization.h

setCropToolOriginalEnabled:

Enables or disables the custom crop size.

+ (void)setCropToolOriginalEnabled:(BOOL)cropToolEnableOriginal

Parameters

cropToolEnableOriginal

YES enables the original crop size, NO disables it.

Discussion

Enables or disables the custom crop size.

The Original crop preset constrains the crop area to photo’s original aspect ratio. By default, original crop size is enabled.

Declared In

AdobeImageEditorCustomization.h

setCropToolPresets:

Sets the availability and order of crop preset options.

+ (void)setCropToolPresets:(NSArray *)cropToolPresets

Parameters

cropToolPresets

An array of crop option dictionaries.

Discussion

Sets the availability and order of crop preset options.

The dictionaries should be of the form:

@{kAdobeImageEditorCropPresetName: , kAdobeImageEditorCropPresetWidth: , kAdobeImageEditorCropPresetHeight: }

When the corresponding option is selected, the crop box will be constrained to a kAdobeImageEditorCropPresetWidth:kAdobeImageEditorCropPresetHeight aspect ratio.

If Original and/or Custom options are enabled, then they will precede the presets defined here. If no crop tool presets are set, the default options are Square, 3x2, 5x3, 4x3, 6x4, and 7x5.

Declared In

AdobeImageEditorCustomization.h

setIconImage:forTool:

Sets the tool’s icon image in the editor’s home bottom bar.

+ (void)setIconImage:(UIImage *__nullable)image forTool:(NSString *)tool

Parameters

image

The image to use.

tool

The tool to set for the image. See the discussion for possible values.

Discussion

Sets the tool’s icon image in the editor’s home bottom bar.

The tool key must be one of the options listed at the top of this header.

Declared In

AdobeImageEditorCustomization.h

setLeftNavigationBarButtonTitle:

Sets the text of the editor’s left navigation bar button.

+ (void)setLeftNavigationBarButtonTitle:(NSString *)leftNavigationBarButtonTitle

Parameters

leftNavigationBarButtonTitle

An NSString value represented by one of the three kAdobeImageEditorLeftNavigationTitlePreset keys.

Discussion

Sets the text of the editor’s left navigation bar button.

Attempting to set any string besides one of the kAdobeImageEditorLeftNavigationTitlePresets will have no effect.

Declared In

AdobeImageEditorCustomization.h

setNavBarImage:

Sets the editor’s navigation bar’s background image.

+ (void)setNavBarImage:(UIImage *__nullable)navBarImage

Parameters

navBarImage

The image to use.

Discussion

Sets the editor’s navigation bar’s background image.

Warning: This method no longer has any effect.

Declared In

AdobeImageEditorCustomization.h

setRightNavigationBarButtonTitle:

Sets the text of the editor’s right navigation bar button.

+ (void)setRightNavigationBarButtonTitle:(NSString *)rightNavigationBarButtonTitle

Parameters

rightNavigationBarButtonTitle

An NSString value represented by one of the three kAdobeImageEditorRightNavigationTitlePreset keys.

Discussion

Sets the text of the editor’s right navigation bar button.

Attempting to set any string besides one of the kAdobeImageEditorRightNavigationTitlePresets will have no effect.

Declared In

AdobeImageEditorCustomization.h

setStatusBarStyle:

Sets the editor’s preferred status bar style when running on a device running iOS 7 and later.

+ (void)setStatusBarStyle:(UIStatusBarStyle)statusBarStyle

Parameters

statusBarStyle

The status bar style to use.

Discussion

Sets the editor’s preferred status bar style when running on a device running iOS 7 and later.

Warning: This method no longer has any effect.

Declared In

AdobeImageEditorCustomization.h

setSupportedIpadOrientations:

Configures the orientations the editor can have on the iPad form factor.

+ (void)setSupportedIpadOrientations:(NSArray *)supportedOrientations

Parameters

supportedOrientations

An NSArray containing NSNumbers each representing a valid UIInterfaceOrientation.

Discussion

Configures the orientations the editor can have on the iPad form factor.

On the iPhone form factor, orientation is always portrait.

Declared In

AdobeImageEditorCustomization.h

setToolOrder:

Sets the type and order of tools to be presented by the editor.

+ (void)setToolOrder:(NSArray *)toolOrder

Parameters

toolOrder

An NSArray containing NSString values represented by one of the tool keys.

Discussion

Sets the type and order of tools to be presented by the editor.

The tool key must be one of the options listed at the top of this header.

Declared In

AdobeImageEditorCustomization.h

setTutorialsEnabled:

Configures whether to show tutorials explaining the editor’s features to users. By default, this is set to YES.

+ (void)setTutorialsEnabled:(BOOL)tutorialsEnabled

Parameters

tutorialsEnabled

whether to enable the the tutorials or not

Discussion

Configures whether to show tutorials explaining the editor’s features to users. By default, this is set to YES.

Declared In

AdobeImageEditorCustomization.h

usePCNStagingEnvironment:

Configures the editor to point at the Premium Content Network’s staging environment.

+ (void)usePCNStagingEnvironment:(BOOL)usePCNStagingEnvironment

Parameters

usePCNStagingEnvironment

YES points the editor to staging, NO points it to production.

Discussion

Configures the editor to point at the Premium Content Network’s staging environment.

By default, the editor points at the production environment. Call this method with YES before editor to launch to view the content in the Premium Content Network staging environment.

Declared In

AdobeImageEditorCustomization.h