/*
 *
 *  ZDChatCell.h
 *  ZDCChat
 *
 *  Created by Zendesk on 24/09/2014.
 *
 *  Copyright (c) 2016 Zendesk. All rights reserved.
 *
 *  By downloading or using the Zendesk Mobile SDK, You agree to the Zendesk Master
 *  Subscription Agreement https://www.zendesk.com/company/customers-partners/#master-subscription-agreement and Application Developer and API License
 *  Agreement https://www.zendesk.com/company/customers-partners/#application-developer-api-license-agreement and
 *  acknowledge that such terms govern Your use of and access to the Mobile SDK.
 *
 */


#import <UIKit/UIKit.h>
#import <ZDCChatAPI/ZDCChatEvent.h>
#import <ZDCChatAPI/ZDCChatAgent.h>
#import "ZDCChatCellActionDelegate.h"


extern CGFloat const ZDC_CHAT_BUBBLE_LEAD_MESSAGE_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_TOP_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_BOTTOM_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_TOP_PADDING;
extern CGFloat const ZDC_CHAT_BUBBLE_BOTTOM_PADDING;
extern CGFloat const ZDC_CHAT_BUBBLE_LEFT_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_LEFT_MARGIN_AGENT;
extern CGFloat const ZDC_CHAT_BUBBLE_RIGHT_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_AGENT_RIGHT_MARGIN;
extern CGFloat const ZDC_CHAT_BUBBLE_LEFT_PADDING;
extern CGFloat const ZDC_CHAT_BUBBLE_RIGHT_PADDING;
extern CGFloat const ZDC_CHAT_BUBBLE_AUTHOR_HEIGHT;
extern CGFloat const ZDC_CHAT_BUBBLE_CORNER_RADIUS;
extern CGFloat const ZDC_TYPING_CELL_HEIGHT;
extern CGFloat const ZDC_TYPING_CELL_HEIGHT_WITH_AVATAR;
extern CGFloat const ZDC_AVATAR_LEFT_INSET;
extern CGFloat const ZDC_AVATAR_TOP_INSET;
extern CGFloat const ZDC_AVATAR_HEIGHT;
extern CGFloat const ZDC_DEFAULT_UNSENT_MSG_TOP_MARGIN;
extern CGFloat const ZDC_DEFAULT_UNSENT_ICON_LEFT_MARGIN;
extern NSString * const ZDC_DEFAULT_UNSENT_ICON_IMAGE;
extern NSString * const ZDC_DEFAULT_BROKEN_FILE_ICON_IMAGE;



#define ZDC_VISITOR_UNSENT_MESSAGE_FONT [UIFont systemFontOfSize:12]
#define ZDC_VISITOR_UNSENT_MESSAGE_COLOR [UIColor colorWithWhite:0.58f alpha:1.0f]



/**
 * Abstract chat cell defining common methods.
 */
@interface ZDCChatCell : UITableViewCell


/**
 * The chat event being presented by this cell.
 */
@property (nonatomic, strong) ZDCChatEvent *event;

/**
 * YES if this cell current showing or transitioning to an error state.
 */
@property (nonatomic, assign) BOOL eventError;

/**
 * Message resend delegate for checking message timeouts and requesting resend.
 */
@property (nonatomic, weak) id<ZDCChatCellActionDelegate> actionDelegate;


/**
 * Update the cell with the event provided.
 * @param event the event to be presented
 */
- (void) prepareWithEvent:(ZDCChatEvent*)event;

/**
 * Notify the cell of an update to the agent record.
 * @param agent the updated agent info
 */
- (void) agentUpdate:(ZDCChatAgent*)agent;

/**
 * Notify the cell that agent(s) are typing.
 * @param agents list of typing agents
 * @param lastEvent the last chat event being shown
 */
- (void) agentsTyping:(NSArray*)agents lastEvent:(ZDCChatEvent*)lastEvent;

/**
 * Get the cell height.
 * @param event the chat event being displayed by thie cell
 * @param width the table/cell width
 * @return the calculated height, if not overridden this method defaults to 44
 */
- (CGFloat) heightForEvent:(ZDCChatEvent*)event givenWidth:(CGFloat)width;

/**
 * Get the appearance value for a given selector, returning the default if not set.
 * @param sel the appearance selector to be used
 * @param defaultVal the default value returned if the appearance has not been set
 * @return the apperance value if set, else the default value
 */
- (id) appearance:(SEL)sel def:(id)defaultVal;

/**
 * Set the appearance properties with either specified values or defaults.
 */
- (void) setupAppearance;


#pragma mark layout

/**
 * Base laout method that decides which layout method to invoke, override to customize layout decisions.
 */
- (void) layout;

/**
 * Layout the event in the standard state, invoked by 'layout' if there is no 'eventError'
 */
- (void) layoutForStatusOk;

/**
 * Layout the event in the error state, invoked by 'layout' if there is an 'eventError'
 */
- (void) layoutForStatusError;

/**
 * Animate this cell from layout 'Ok' to layout 'Error'.
 */
- (void) animateToError;

/**
 * Animate this cell from layout 'Error' to layout 'Ok'.
 */
- (void) animateToOk;

/**
 * Animate a user action in thie cell.
 */
- (void) animateUserAction:(NSDictionary*)info;

/**
 * Helper for getting the image size for presentation.
 * @param event the attachment event
 * @param maxSize the max width/height for the image given the current cell
 */
- (CGSize) attachmentImageSize:(ZDCChatEvent*)event withMaxSize:(float)maxSize;


@end