com.foxit.sdk.pdf.annots.Screen Class Reference
Inheritance diagram for com.foxit.sdk.pdf.annots.Screen:
com.foxit.sdk.pdf.annots.Annot com.foxit.sdk.common.Base

Public Member Functions

 Screen ()
 Constructor.

 
 Screen (Annot annot)
 Constructor, with parent class object. More...
 
Action getAction () throws com.foxit.sdk.PDFException
 Get action. More...
 
PDFDictionary getMKDict () throws com.foxit.sdk.PDFException
 Get the appearance characteristics dictionary (known as "MK" dictionary as well). More...
 
float getOpacity () throws com.foxit.sdk.PDFException
 Get opacity value. More...
 
int getRotation () throws com.foxit.sdk.PDFException
 Get the rotation of the image used for the appearance of current screen annotation. More...
 
String getTitle () throws com.foxit.sdk.PDFException
 Get title of current screen annotation. More...
 
void removeAction () throws com.foxit.sdk.PDFException
 Remove action. More...
 
void setAction (Action action) throws com.foxit.sdk.PDFException
 Set action. More...
 
void setImage (Image image, int frame_index, int compress) throws com.foxit.sdk.PDFException
 Set image to current screen annotation, with a specified frame index. More...
 
void setMKDict (PDFDictionary dict) throws com.foxit.sdk.PDFException
 Set the appearance characteristics dictionary (known as "MK" dictionary as well). More...
 
void setOpacity (float opacity) throws com.foxit.sdk.PDFException
 Set opacity value. More...
 
void setRotation (int rotate) throws com.foxit.sdk.PDFException
 Set the rotation of the image used for the appearance of current screen annotation. More...
 
void setTitle (String title) throws com.foxit.sdk.PDFException
 Set title of current screen annotation. More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.annots.Annot
 Annot (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
 Constructor, with PDF page and annotation's PDF dictionary. More...
 
 Annot (Annot annot)
 Constructor, with another Annot object. More...
 
 Annot ()
 Constructor.

 
PDFStream getAppearanceStream (int type, String appearance_state) throws com.foxit.sdk.PDFException
 Get annotation's appearance stream with specified type and state. More...
 
long getBorderColor () throws com.foxit.sdk.PDFException
 Get border color. More...
 
BorderInfo getBorderInfo () throws com.foxit.sdk.PDFException
 Get border information. More...
 
String getContent () throws com.foxit.sdk.PDFException
 Get content. More...
 
RectI getDeviceRect (boolean is_transform_icon, Matrix2D matrix) throws com.foxit.sdk.PDFException
 Get annotation rectangle in device coordinate system. More...
 
PDFDictionary getDict () throws com.foxit.sdk.PDFException
 Get annotation's dictionary object. More...
 
int getFlags () throws com.foxit.sdk.PDFException
 Get annotation flags. More...
 
int getIndex () throws com.foxit.sdk.PDFException
 Get the index of current annotation in the page which current annotation belongs to. More...
 
DateTime getModifiedDateTime () throws com.foxit.sdk.PDFException
 Get last modified date time. More...
 
PDFDictionary getOptionalContent () throws com.foxit.sdk.PDFException
 Get the PDF dictionary of annotation's optional content. More...
 
PDFPage getPage () throws com.foxit.sdk.PDFException
 Get the related PDF page. More...
 
RectF getRect () throws com.foxit.sdk.PDFException
 Get rectangle, in PDF coordinate system . More...
 
int getType () throws com.foxit.sdk.PDFException
 Get actual annotation type of current annotation. More...
 
String getUniqueID () throws com.foxit.sdk.PDFException
 Get unique ID. More...
 
boolean isEmpty ()
 Check whether current object is empty or not. More...
 
boolean isMarkup () throws com.foxit.sdk.PDFException
 Check if current annotation is a markup annotation. More...
 
boolean move (RectF rect) throws com.foxit.sdk.PDFException
 Move current annotation to a new position, specified by a new rectangle in PDF coordinate system . More...
 
boolean removeProperty (int property) throws com.foxit.sdk.PDFException
 Remove a specified annotation's property. More...
 
boolean resetAppearanceStream () throws com.foxit.sdk.PDFException
 Reset appearance stream. More...
 
void setBorderColor (long color) throws com.foxit.sdk.PDFException
 Set border color. More...
 
void setBorderInfo (BorderInfo border) throws com.foxit.sdk.PDFException
 Set border information. More...
 
void setContent (String content) throws com.foxit.sdk.PDFException
 Set content. More...
 
void setFlags (int flags) throws com.foxit.sdk.PDFException
 Set annotation flags. More...
 
void setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
 Set last modified date time. More...
 
void setUniqueID (String unique_id) throws com.foxit.sdk.PDFException
 Set unique ID. More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.foxit.sdk.pdf.annots.Annot
static final int e_3D = 25
 Annotation type: 3D annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_AppearanceTypeDown = 2
 Annotation's down appearance.
 
static final int e_AppearanceTypeNormal = 0
 Annotation's normal appearance.
 
static final int e_AppearanceTypeRollover = 1
 Annotation's rollover appearance.
 
static final int e_Caret = 14
 Annotation type: caret annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Circle = 6
 Annotation type: circle annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_FileAttachment = 17
 Annotation type: file attachment annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_FlagHidden = 0x0002
 Annotation flag: hidden. More...
 
static final int e_FlagInvisible = 0x0001
 Annotation flag: invisible. More...
 
static final int e_FlagLocked = 0x0080
 Annotation flag: locked. More...
 
static final int e_FlagLockedContents = 0x0200
 Annotation flag: locked contents. More...
 
static final int e_FlagNoRotate = 0x0010
 Annotation flag: no rotate. More...
 
static final int e_FlagNoView = 0x0020
 Annotation flag: no view. More...
 
static final int e_FlagNoZoom = 0x0008
 Annotation flag: no zoom. More...
 
static final int e_FlagPrint = 0x0004
 Annotation flag: print. More...
 
static final int e_FlagReadOnly = 0x0040
 Annotation flag: read only. More...
 
static final int e_FlagToggleNoView = 0x0100
 Annotation flag: toggle no view. More...
 
static final int e_FreeText = 3
 Annotation type: free text annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Highlight = 9
 Annotation type: highlight annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_HighlightingInvert = 1
 Highlighting mode: Invert, which is to invert the contents of the annotation rectangle.
 
static final int e_HighlightingNone = 0
 Highlighting mode: No highlighting.
 
static final int e_HighlightingOutline = 2
 Highlighting mode: Outline, which is to invert the annotation's border.
 
static final int e_HighlightingPush = 3
 Highlighting mode: Push, which is to display the annotation's down appearance, if any.
 
static final int e_HighlightingToggle = 4
 Highlighting mode: Toggle. This is only useful for widget annotation.
 
static final int e_Ink = 15
 Annotation type: ink annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Line = 4
 Annotation type: line annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Link = 2
 Annotation type: link annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_MKEntryBackgroundColor = 2
 Background color entry. "BG" in MK dictionary.
 
static final int e_MKEntryBorderColor = 1
 Border color entry. "BC" in MK dictionary.
 
static final int e_MKEntryDownCaption = 5
 Down caption (or alternate caption) entry. "AC" in MK dictionary. More...
 
static final int e_MKEntryDownIcon = 8
 Down icon (or alternate icon) entry. "IX" in MK dictionary. More...
 
static final int e_MKEntryIconCaptionRelation = 10
 Icon and caption relation entry. "TP" in MK dictionary. More...
 
static final int e_MKEntryIconFit = 9
 Icon fit information entry. "IF" in MK dictionary. More...
 
static final int e_MKEntryNormalCaption = 3
 Normal caption entry. "CA" in MK dictionary. More...
 
static final int e_MKEntryNormalIcon = 6
 Normal icon entry. "I" in MK dictionary. More...
 
static final int e_MKEntryRolloverCaption = 4
 Rollover caption entry. "RC" in MK dictionary. More...
 
static final int e_MKEntryRolloverIcon = 7
 Rollover icon entry. "RI" in MK dictionary. More...
 
static final int e_MKEntryRotation = 0
 Rotation entry. "R" in MK dictionary.
 
static final int e_MKRelationCaptionAboveIcon = 3
 Caption above the icon.
 
static final int e_MKRelationCaptionBelowIcon = 2
 Caption below the icon.
 
static final int e_MKRelationCaptionLeft = 5
 Caption to the left of the icon.
 
static final int e_MKRelationCaptionOvrlayOnIcon = 6
 Caption overlaid directly on the icon.
 
static final int e_MKRelationCaptionRight = 4
 Caption to the right of the icon.
 
static final int e_MKRelationNoCaption = 1
 No caption; icon only.
 
static final int e_MKRelationNoIcon = 0
 No icon; captin only.
 
static final int e_Movie = 19
 Annotation type: movie annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Note = 1
 Annotation type: note annotation, which is just "Text" annotation - one of standard annotation in <PDF reference 1.7>.
 
static final int e_Polygon = 7
 Annotation type: polygon annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_PolyLine = 8
 Annotation type: polyline annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Popup = 26
 Annotation type: pop-up annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_PrinterMark = 22
 Annotation type: printer's mark annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_PropertyBorderColor = 2
 Annotation property: border color.
 
static final int e_PropertyCreationDate = 1
 Annotation property: creation date. More...
 
static final int e_PropertyFillColor = 3
 Annotation property: fill color. More...
 
static final int e_PropertyModifiedDate = 0
 Annotation property: modified date.
 
static final int e_PSInk = 16
 Annotation type: pressure sensitive ink annotation.
 
static final int e_Redact = 27
 Annotation type: redact annotation.
 
static final int e_Screen = 21
 Annotation type: screen annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Sound = 18
 Annotation type: sound annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Square = 5
 Annotation type: square annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Squiggly = 11
 Annotation type: squiggly annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Stamp = 13
 Annotation type: stamp annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_StrikeOut = 12
 Annotation type: strikeout annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_TrapNet = 23
 Annotation type: trap network annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Underline = 10
 Annotation type: underline annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_UnknownType = 0
 Annotation type: unknown.
 
static final int e_Watermark = 24
 Annotation type: watermark annotation. One of standard annotation in <PDF reference 1.7>.
 
static final int e_Widget = 20
 Annotation type: widget annotation. One of standard annotation in <PDF reference 1.7>. More...
 

Detailed Description

A screen annotation specifies a region of a page upon which media clips may be played. It also serves as an object from which actions can be triggered. Usually, rendition action is set to a screen annotation in order that the screen annotation can be used to play media clip.
Class Screen is derived from FSAnnot, and offers functions to get/set link annotation's properties and reset appearance stream of a screen annotation. Appearance stream of a screen annotation is used for printing (if possible) and when the related media clip is not being played.

Note
For a newly created screen annotation, it has no border information and no border color.
See also
Annot

Constructor & Destructor Documentation

◆ Screen()

com.foxit.sdk.pdf.annots.Screen.Screen ( Annot  annot)

Constructor, with parent class object.

Parameters
annotParent class object.

Member Function Documentation

◆ getAction()

Action com.foxit.sdk.pdf.annots.Screen.getAction ( ) throws com.foxit.sdk.PDFException

Get action.

This function cannot be used to get action which is used as additional action. If user wants to get any additional action, please refer to class actions::AdditionalAction for more details.

Returns
An Action object that receives the action data. If the return value of function actions::Action::isEmpty for the returned Action object is true, that means no action.

◆ getMKDict()

PDFDictionary com.foxit.sdk.pdf.annots.Screen.getMKDict ( ) throws com.foxit.sdk.PDFException

Get the appearance characteristics dictionary (known as "MK" dictionary as well).

Returns
A PDF dictionary that represents the "MK" dictionary. If this dictionary is not set to a screen annotation (including current one), please call function objects::PDFDictionary::release to release it.

◆ getOpacity()

float com.foxit.sdk.pdf.annots.Screen.getOpacity ( ) throws com.foxit.sdk.PDFException

Get opacity value.

This property has effect on annotation's appearance.

Returns
The opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque.

◆ getRotation()

int com.foxit.sdk.pdf.annots.Screen.getRotation ( ) throws com.foxit.sdk.PDFException

Get the rotation of the image used for the appearance of current screen annotation.

Returns
Rotation value of the image. Please refer to values starting from e_Rotation0 and this would be one of these values.

◆ getTitle()

String com.foxit.sdk.pdf.annots.Screen.getTitle ( ) throws com.foxit.sdk.PDFException

Get title of current screen annotation.

Returns
The title string.

◆ removeAction()

void com.foxit.sdk.pdf.annots.Screen.removeAction ( ) throws com.foxit.sdk.PDFException

Remove action.

This function cannot be used to remove action which is used as additional action. If user wants to remove any additional action, please refer to class actions::AdditionalAction for more details.

Returns
true means success, while false means failure.

◆ setAction()

void com.foxit.sdk.pdf.annots.Screen.setAction ( Action  action) throws com.foxit.sdk.PDFException

Set action.

This function cannot be used to set action which is used as additional action. If user wants to set any additional action, please refer to class actions::AdditionalAction for more details.

Parameters
actionNew action to be set. It should be valid. Currently only support following types as the new action: actions::e_TypeGoto, actions::e_TypeURI, actions::e_TypeJavaScript, actions::e_TypeNamed, actions::e_TypeGoToR, actions::e_TypeGoToE, actions::e_TypeSubmitForm, actions::e_TypeResetForm, actions::e_TypeHide, actions::e_TypeLaunch, actions::e_TypeImportData, actions::e_TypeRendition.
Returns
None.

◆ setImage()

void com.foxit.sdk.pdf.annots.Screen.setImage ( Image  image,
int  frame_index,
int  compress 
) throws com.foxit.sdk.PDFException

Set image to current screen 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 effect to be shown in annotation's appearance, please call function Annot::resetAppearanceStream after this function.

Parameters
imageAn 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 common::e_Unknown.
frame_indexFrame index. Valid range: from 0 to (count-1). count is returned by function common::Image::getFrameCount.
compressCompress algorithm type used to compress image data. Currently, it only supports 2 valid value:

0: no compress.
1: do default compress.

Returns
None.

◆ setMKDict()

void com.foxit.sdk.pdf.annots.Screen.setMKDict ( PDFDictionary  dict) throws com.foxit.sdk.PDFException

Set the appearance characteristics dictionary (known as "MK" dictionary as well).

Parameters
dictA PDF dictionary that represents the new "MK" dictionary to be set. User should not release this dictionary after setting it to a screen annotation.

◆ setOpacity()

void com.foxit.sdk.pdf.annots.Screen.setOpacity ( float  opacity) throws com.foxit.sdk.PDFException

Set opacity value.

This property has effect on annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function Annot::resetAppearanceStream after this function.

Parameters
opacityThe new opacity value. Valid range: 0.0 to 1.0 . 0.0 means full transparency and 1.0 means full opaque.
Returns
None.

◆ setRotation()

void com.foxit.sdk.pdf.annots.Screen.setRotation ( int  rotate) throws com.foxit.sdk.PDFException

Set the rotation of the image used for the appearance of current screen annotation.

This property has effect on annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function Annot::resetAppearanceStream after this function.

Parameters
rotateRotation value. Please refer to values starting from e_Rotation0 and this should be one of these values except e_RotationUnknown.
Returns
None.

◆ setTitle()

void com.foxit.sdk.pdf.annots.Screen.setTitle ( String  title) throws com.foxit.sdk.PDFException

Set title of current screen annotation.

Parameters
titleThe title string to be set.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.