DcsUIDocumentEditorView

Description

A class for the document editor view.

Members

Member Type Member Name Description
Property DcsViewEnum nextViewAfterCancel Gets or sets the view to navigate to when the cancel tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Property DcsViewEnum nextViewAfterOK Gets or sets the view to navigate to when the OK tool item is tapped. The default value is DVE_IMAGEGALLERYVIEW.
Property UIColor * documentBoundaryColor Gets or sets the document border color. The default is #5eb7e4.
Property NSInteger documentBoundaryThickness Gets or sets the document border thickness. The default is 6px.
Property NSString* brightnessText Gets or sets the text showed on the Brightness tool item on the document editor viewer. The default value is "Brightness".
Property NSString* contrastText Gets or sets the text showed on the Contrast tool item on the document editor viewer. The default value is "Contrast".
Property NSString * colorText Gets or sets the text showed on the ColorMode tool item on the document editor viewer. The default value is "Color".
Property NSString * greyText Gets or sets the text showed on the GreyMode tool item on the document editor viewer. The default value is "Grey".
Property NSString * blackWhiteText Gets or sets the text showed on the B/W Mode tool item on the document editor viewer. The default value is "B/W".
Property NSString * cancelText Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Property NSString * okText Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".
Property BOOL showRotateLeftToolItem Gets or sets whether to show the RotateLeft tool item. The default value is "YES".
Property BOOL showRotateRightToolItem Gets or sets whether to show the RotateRight tool item. The default value is "YES".
Property BOOL showBrightnessToolItem Gets or sets whether to show the Brightness tool item. The default value is "YES".
Property BOOL showContrastToolItem Gets or sets whether to show the Contrast tool item. The default value is "YES".
Property BOOL showImageModeToolItem Gets or sets whether to show the ImageMode tool item. The default value is "YES".
Property UIImage * rotateLeftIcon Gets or sets the icon showed on RotateLeft tool item on the document editor viewer.
Property UIImage * rotateRightIcon Gets or sets the icon showed on RotateRight tool item on the document editor viewer.
Property UIImage * imageModeIcon Gets or sets the icon showed on the ImageMode tool item on the document editor viewer.
Property UIImage * colorModeIcon Gets or sets the icon showed on the ColorMode tool item on the document editor viewer.
Property UIImage * greyModeIcon Gets or sets the icon showed on the GreyMode tool item on the document editor viewer.
Property UIImage * blackWhiteIcon Gets or sets the icon showed on the B/W tool item on the document editor viewer.
Property UIImage * brightnessContrastIcon Gets or sets the icon showed on the Brightness and Contrast tool item on the document editor viewer.
delegate (void) onCancelTapped: (id) sender The event is fired when the cancel tool item is clicked.
delegate (void) onOkTapped: (id) sender The event is fired when the OK tool item is clicked.
Method (void) adjustContrast:
(NSInteger) contrast
Adjusts the contrast of the document.
Method (void) adjustBrightness:
(NSInteger) brightness
Adjusts the brightness of the document.
Method (void) rotateLeft Rotates the document in the editor by 90 degrees counter-clockwise.
Method (void) rotateRight Rotates the document in the editor by 90 degrees clockwise.
Method (void) toColor Converts to a 24-bit RGB document.
Method (void) toGrey Converts to a greyscale document.
Method (void) toBlackWhite Converts to a black and white document.
Method (void) save Saves the changes made to the document.
Method (void) discard Discards the changes made to the document.
typedef enum DcsViewEnum

DVE_VIDEOVIEW=0x0010 Video view
DVE_IMAGEGALLERYVIEW Image gallery view
DVE_EDITORVIEW Edit view. When the data you operate with is a document, it displays the document editor. If it's an image, then it displays the image editor.
(nonatomic, assign) DcsViewEnum nextViewAfterCancel
Description Gets or sets the view to navigate to when the cancel tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Remarks If it's set to DVE_VIDEOVIEW, when the cancel button is clicked, the current page redirects to the video view.

If it's set to DVE_IMAGEGALLERYVIEW, when the cancel button on the video view page is clicked, the current page redirects to the image gallery view.

If it's set to DVE_EDITORVIEW, when the cancel button is clicked, the current page remains no change.

If the value equals nil, it means the set fails, the exception DcsValueNotValidException will be thrown.

(nonatomic, assign) DcsViewEnum nextViewAfterOK
Description Gets or sets the view to navigate to when the OK tool item is tapped. The default value is DEV_IMAGEGALLERYVIEW.
Remarks If it's set to DVE_VIDEOVIEW, when the OK button is clicked, the current page redirects to the video viewer.

If it's set to DVE_IMAGEGALLERYVIEW, when the capture button on the video view page is clicked, the current page redirects to the image gallery view.

If it's set to DVE_EDITORVIEW, when the OK button is clicked, the current page remains no change.

If the value equals nil, it means the set fails, the exception DcsValueNotValidException will be thrown.

(nonatomic, strong) UIColor *documentBoundaryColor
Description Gets or sets the document border color. The default is #5eb7e4.
Remarks If it's set to a non UIColor object, the exception DcsTypeNotValidException will be thrown.

the value equals nil, it means the set fails, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSInteger documentBoundaryThickness
Description Gets or sets the document border thickness. The default is 6px.
Remarks If the value you set is below 0 or equals 0, the set fails and the boundry of the document remains the same.
(nonatomic, strong) NSString * brightnessText
Description Gets or sets the text showed on the Brightness tool item on the document editor viewer. The default value is "Brightness".
Remarks If it is set to nil, no text will be showed on the Brightness tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * contrastText
Description Gets or sets the text showed on the Contrast tool item on the document editor viewer. The default value is "Contrast".
Remarks If it is set to nil, no text will be showed on the Contrast tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * colorText
Description Gets or sets the text showed on the ColorMode tool item on the document editor viewer. The default value is "Color".
Remarks If it is set to nil, no text will be showed on the ColorMode tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * greyText
Description Gets or sets the text showed on the GreyMode tool item on the document editor viewer. The default value is "Grey".
Remarks If it is set to nil, no text will be showed on the GreyMode tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * blackWhiteText
Description Gets or sets the text showed on the B/W tool item on the document editor viewer. The default value is "B/W".
Remarks If it is set to nil, no text will be showed on the B/W tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * cancelText
Description Gets or sets the text showed on the Cancel tool item on the document editor viewer. The default value is "Cancel".
Remarks If it is set to nil, no text will be showed on the Cancel tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) NSString * okText
Description Gets or sets the text showed on the OK tool item on the document editor viewer. The default value is "OK".
Remarks If it is set to nil, no text will be showed on the OK tool item on the document editor viewer.

If the value is not the NSString type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * rotateLeftIcon
Description Gets or sets the icon showed on RotateLeft tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateLeft tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * rotateRightIcon
Description Gets or sets the icon showed on RotateRight tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the RotateRight tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * colorModeIcon
Description Gets or sets the icon showed on ColorMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the ColorMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * greyModeIcon
Description Gets or sets the icon showed on GreyMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the GreyMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * blackWhiteIcon
Description Gets or sets the icon showed on B/W tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the B/W tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * imageModeIcon
Description Gets or sets the icon showed on ImageMode tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the ImageMode tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.

(nonatomic, strong) UIImage * brightnessContrastIcon
Description Gets or sets the icon showed on BrightnessContrast tool item on the document editor viewer.
Remarks If it is set to nil, no icon will be showed on the BrightnessContrast tool item on the document editor viewer.

If the value is not the UIImage type, the exception DcsTypeNotValidException will be thrown.