SMPOpenUIEmbeddedImageDisplayModel protocol

Model protocol of object provided to an adapter used for an extension field representing an Embedded Image.

Syntax

@protocol SMPOpenUIEmbeddedImageDisplayModel

Base protocols

Members

All members of SMPOpenUIEmbeddedImageDisplayModel, including inherited members.

Methods
Method Description
- (void) imageCellClickedAtRow: (NSUInteger) row andColumn: (NSUInteger) column Call this to inform agentry that a cell at a given position has been clicked.
- (BOOL) isImageCellSelectedAtRow: (NSUInteger) row andColumn: (NSUInteger) column Call this to find out whether a cell at a given position has been clicked.
Properties
Property Description
@property (nonatomic,readonly) NSUInteger columns The number of columns defined for the image.
@property (nonatomic,readonly) UIColor * highlightSelectedColor The highlight selected color to use for the selected cells.
@property (nonatomic,readonly) SMPOpenUIImage * image The image to display.
@property (nonatomic,readonly) NSUInteger rows The number of rows defined for the image.
Inherited members from SMPOpenUIFieldModel
Member Description
- (SMPOpenUIActionEnableType) agentryActionEnableState: (NSString *) actionName Asks Agentry what the current enable state is for the action specified by name.
- (NSString *) agentryString: (NSString *) stringName Asks Agentry for a specific string value.
@property (nonatomic,readonly) BOOL autosizing A Boolean value representing whether the field is set to Auto height in the Editor.
@property (nonatomic,readonly) BOOL enabled A Boolean value representing whether the field is currently enabled based on current rule evaluation.
- (SMPOpenUIActionResult) executeAgentryAction: (NSString *) actionName Asks Agentry to execute the action specified by name.
- (SMPOpenUIActionResult) executeHyperlinkAction Executes the field's hyperlink action (if the hyperlink action is enabled).
@property (nonatomic,readonly) BOOL hidden A Boolean value representing whether or not the field is currently hidden based on current rule evaluations.
@property (nonatomic,readonly) BOOL hyperlinkEnabled A Boolean value representing whether or not the hyperlink action is enabled.
@property (nonatomic,readonly) NSString * label The label the field would like the extension to display.
- (void) requestLayoutHeigh: (NSUInteger) newHeight Used to inform Agentry that a new height is desired for an autosizing field.

Usage

An Embedded Image can be sectioned into a grid of rows and columns, and each cell can be selected or not. Agentry Actions might also be launched as a result of selecting a cell.