Foxit PDF SDK
|
Instance Methods | |
(id) | - init |
Constructor. | |
(id) | - initWithAnnot: |
Constructor, with parent class object. More... | |
(void) | - rotate: |
Rotate current annotation from current state with specified angle degree in clockwise. More... | |
(void) | - setBitmap: |
Set bitmap to current stamp annotation. More... | |
(void) | - setImage:frame_index:compress: |
Set image to current stamp annotation, with a specified frame index. More... | |
![]() | |
(FSNote *) | - addReply |
Add a new reply to the end of reply list. More... | |
(FSNote *) | - addStateAnnot:state: |
Add a new state annotation. More... | |
(FSMarkupArray *) | - getGroupElements |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
(FSMarkup *) | - getGroupHeader |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
(FSNote *) | - getReply: |
Get a reply by index. More... | |
(int) | - getReplyCount |
Count all replies. More... | |
(FSNote *) | - getStateAnnot:index: |
Get a state annotation, under a specified state model. More... | |
(int) | - getStateAnnotCount: |
Get the count of state annotations, under a specified state model. More... | |
(BOOL) | - isGrouped |
Check whether current markup annotation is in a group or not. More... | |
(BOOL) | - removeAllReplies |
Remove all the replies. More... | |
(BOOL) | - removeAllStateAnnots |
Remove all state annotations. More... | |
(BOOL) | - removeReply: |
Remove a reply by index. More... | |
(BOOL) | - ungroup |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
(FSPDFStream *) | - getAppearanceStream:appearance_state: |
Get annotation's appearance stream with specified type and state. More... | |
(FSRectI *) | - getDeviceRect: |
Get annotation rectangle in device coordinate system. More... | |
(FSPDFDictionary *) | - getDict |
Get annotation's dictionary object. More... | |
(FSMatrix2D *) | - getDisplayMatrix: |
Get the display matrix, from to targeted device coordinate system. More... | |
(int) | - getIndex |
Get the index of current annotation in the page which current annotation belongs to. More... | |
(FSPDFDictionary *) | - getOptionalContent |
Get the PDF dictionary of annotation's optional content. More... | |
(FSPDFPage *) | - getPage |
Get the related PDF page. More... | |
(FSRectF *) | - getRect |
Get rectangle, in . More... | |
(FSAnnotType) | - getType |
Get actual annotation type of current annotation. More... | |
(id) | - initWithPage:annot_dict: |
Constructor, with PDF page and annotation's PDF dictionary. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(BOOL) | - isMarkup |
Check if current annotation is a markup annotation. More... | |
(BOOL) | - move: |
Move current annotation to a new position, specified by a new rectangle in . More... | |
(BOOL) | - removeProperty: |
Remove a specified annotation's property. More... | |
(BOOL) | - resetAppearanceStream |
Reset appearance stream. More... | |
Properties | |
NSString * | iconName |
Get or Set icon name. More... | |
int | rotation |
Get or Set current rotation angle (in clockwise). | |
![]() | |
FSDateTime * | creationDateTime |
Get or Set creation date time. | |
NSString * | intent |
Get or Set intent name. More... | |
float | opacity |
Get or Set opacity value. More... | |
FSPopup * | popup |
Get or Set related pop-up annotation. More... | |
NSString * | subject |
Get or Set subject string. | |
NSString * | title |
Get or Set title string. | |
![]() | |
unsigned int | borderColor |
Get or Set border color. More... | |
FSBorderInfo * | borderInfo |
Get or Set border information. More... | |
NSString * | content |
Get or Set content. | |
unsigned int | flags |
Get or Set annotation flags. | |
FSDateTime * | modifiedDateTime |
Get or Set last modified date time. | |
NSString * | uniqueID |
Get or Set unique ID. | |
A stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
A stamp annotation's appearance can be with an icon or a bitmap. Currently, Foxit PDF SDK does not have any default appearance for predefined standard stamp icons, so user should set a customized annotation icon provider to Foxit PDF SDK by function FSLibrary::setAnnotIconProviderCallback: if the stamp is represented by icon.
Stamp annotation is a kind of markup annotation, so class FSStamp is derived from class FSMarkup , and also offers functions to get/set stamp annotation's properties and reset appearance stream of a stamp annotation.
Before resetting appearance stream of a stamp annotation, please ensure a stamp annotation has been set valid bitmap or image, or it has an icon name with the supported customized annotation icon provider being set to Foxit PDF SDK; otherwise the stamp annotation cannot be reset appearance stream.
- (id) initWithAnnot: | (FSAnnot*) | annot |
Constructor, with parent class object.
[in] | annot | Parent class object. |
Reimplemented from FSMarkup.
- (void) rotate: | (int) | angle |
Rotate current annotation from current state with specified angle degree in clockwise.
[in] | angle | Angle degree value, which is used to rotate current annotation from current state in clockwise. Value range: from 0 to 360. Specially, if the input value is 0 or 360 (which means not to rotate current annotation), current function will do nothing. |
- (void) setBitmap: | (FSBitmap*) | bitmap |
Set bitmap to current stamp annotation.
If user wants the new bitmap has effect on annotation's appearance, please call function FSAnnot::resetAppearanceStream after setting the new bitmap.
[in] | bitmap | A bitmap to be set to current stamp. |
- (void) setImage: | (FSImage*) | image | |
frame_index: | (int) | frame_index | |
compress: | (int) | compress | |
Set image to current stamp annotation, with a specified frame index.
Input image may contain multiple frames, and only one frame of the image can be set to current stamp annotation.
If user wants the new image has effect on annotation's appearance, please call function FSAnnot::resetAppearanceStream after setting the new image.
[in] | image | An image. One of its frames will be set to current stamp. This image contains at least one frame and the image type should not be FSImageUnknown. |
[in] | frame_index | Frame index. Valid range: from 0 to (count-1). count is returned by function FSImage::getFrameCount. |
[in] | compress | Compress algorithm type used to compress image data. Currently, it only supports 2 valid value:
|
|
readwritenonatomicweak |
Get or Set icon name.
This property may has effect on stamp annotation's appearance when a supported customized annotation icon provider being set to Foxit PDF SDK. Stamp annotation has predefined standard icon names:
"Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret".