Foxit PDF SDK
com.foxit.sdk.addon.xfa.AppProviderCallback类 参考

Public 成员函数

void beep (int type)
 用于为指定的蜂鸣类型发出蜂鸣声的回调函数。 更多...
 
FileReaderCallback downLoadUrl (String url)
 用于从指定 URL 下载的回调函数。 更多...
 
String getAppInfo (int app_info)
 用于获取指定信息类型的应用程序信息的回调函数。 更多...
 
String loadString (int string_id)
 用于为指定情况加载本地语言字符串的回调函数。 更多...
 
int msgBox (String message, String title, int icon_type, int button_type)
 用于设置消息框的回调函数。 更多...
 
String postRequestURL (String url, String data, String content_type, String encode, String header)
 用于将数据发布到给定 URL 的回调函数。 更多...
 
boolean putRequestURL (String url, String data, String encode)
 用于将数据放置到给定 URL 的回调函数。 更多...
 
void release ()
 用于释放当前回调对象本身的回调函数。 更多...
 
String response (String question, String title, String default_answer, boolean is_mask)
 用于响应的回调函数。 更多...
 
WStringArray showFileDialog (String string_title, String string_filter, boolean is_openfile_dialog)
 用于显示文件对话框的回调函数。 更多...
 

静态 Public 属性

static final int e_AppInfoLanguage = 0x01
 应用程序信息:语言。
 
static final int e_AppInfoName = 0x04
 应用程序信息:名称。
 
static final int e_AppInfoPlatform = 0x02
 应用程序信息:平台。
 
static final int e_AppInfoType = 0x05
 应用程序信息:类型。
 
static final int e_AppInfoVariation = 0x03
 应用程序信息:变体。
 
static final int e_AppInfoVersion = 0x0
 应用程序信息:版本。
 
static final int e_BeepTypeDefault = 4
 蜂鸣类型:默认。
 
static final int e_BeepTypeError = 0
 蜂鸣类型:错误。
 
static final int e_BeepTypeQuestion = 2
 蜂鸣类型:询问。
 
static final int e_BeepTypeStatus = 3
 蜂鸣类型:状态。
 
static final int e_BeepTypeWarning = 1
 蜂鸣类型:警告。
 
static final int e_MsgBoxIconError = 0
 消息框图标:错误。
 
static final int e_MsgBoxIconQuestion = 2
 消息框图标:问题。
 
static final int e_MsgBoxIconStatus = 3
 消息框图标:状态。
 
static final int e_MsgBoxIconWarning = 1
 消息框图标:警告。
 
static final int e_MsgBtnIDCancel = 2
 消息框按钮 ID:取消。
 
static final int e_MsgBtnIDNo = 3
 消息框按钮 ID:否。
 
static final int e_MsgBtnIDOK = 1
 消息框按钮 ID:确定。
 
static final int e_MsgBtnIDYes = 4
 消息框按钮 ID:是。
 
static final int e_MsgBtnTypeOK = 0
 消息框按钮:确定。
 
static final int e_MsgBtnTypeOKCancel = 1
 消息框按钮:确定和取消。
 
static final int e_MsgBtnTypeYesNo = 2
 消息框按钮:是和否。
 
static final int e_MsgBtnTypeYesNoCancel = 3
 消息框按钮:是、否和取消。
 
static final int e_StringIDAccessProertyInNotObject = 61
 示例消息:"尝试引用非对象的属性 '%s',在 SOM 表达式 %s 中"。
 
static final int e_StringIDAppName = 5
 用于情况的字符串 ID:应用程序名称。示例消息:"Foxit Phantom"。
 
static final int e_StringIDArgumentExpectContainer = 60
 示例消息:"'%s' 参数应该是一个容器"。
 
static final int e_StringIDArgumentMismatch = 66
 示例消息:"属性或函数参数中的参数不匹配"。
 
static final int e_StringIDArgumentNotArray = 59
 示例消息:"'%s' 函数的第 %d 个参数不能是数组"。
 
static final int e_StringIDBadSuffix = 26
 示例消息:"数字后缀错误"。
 
static final int e_StringIDCalcOverride = 2
 示例消息:"计算覆盖"。
 
static final int e_StringIDCannotAssign = 54
 示例消息:"无法赋值给 '%s'"。
 
static final int e_StringIDCannotCovertToObject = 45
 示例消息:"%s.%s 无法转换为对象"。
 
static final int e_StringIDCannotModifyValue = 36
 示例消息:"无法修改 '%s' 值"。
 
static final int e_StringIDCompilerError = 35
 示例消息:"编译器错误"。
 
static final int e_StringIDConditionIsNull = 40
 示例消息:"条件为空"。
 
static final int e_StringIDDivideZero = 44
 示例消息:"除零错误"。
 
static final int e_StringIDErrorMessage = 63
 示例消息:"%s : %s"。
 
static final int e_StringIDExpectedEndIf = 38
 示例消息:"期望 'endif' 而不是 '%s'"。
 
static final int e_StringIDExpectedIdent = 27
 示例消息:"期望标识符而不是 '%s'"。
 
static final int e_StringIDExpectedNumber = 52
 示例消息:"期望数字而不是 '%s'"。
 
static final int e_StringIDExpectedOperator = 43
 示例消息:"期望操作符 '%s' 而不是 '%s'"。
 
static final int e_StringIDExpectedString = 28
 示例消息:"期望 '%s' 而不是 '%s'"。
 
static final int e_StringIDFunctionBuildIn = 62
 示例消息:"函数 's' 是内置的。
 
static final int e_StringIDIllegalBreak = 41
 示例消息:"非法中断"。
 
static final int e_StringIDIllegalContinue = 42
 示例消息:"非法继续"。
 
static final int e_StringIDImageFilter = 6
 用于情况的字符串 ID:图像文件过滤器。示例消息: "图像文件(*.bmp;*.jpg;*.png;*.gif;*.tif)|*.bmp;*.jpg;*.png;*.gif;*.tif|所有文件(*.*)|*.*||"。
 
static final int e_StringIDIncorrectNumberOfMethod = 65
 示例消息:"调用方法 '%s' 时使用的参数数量不正确"。
 
static final int e_StringIDIndexValueOutOfBounds = 64
 示例消息:"索引值超出范围"。
 
static final int e_StringIDInvalidAppend = 68
 示例消息:"无效的追加操作:%s 不能有 %s 的子元素"。
 
static final int e_StringIDInvalidateChar = 29
 示例消息:"无效字符 '%c'"。
 
static final int e_StringIDInvalidateInstruction = 51
 示例消息:"无效指令"。
 
static final int e_StringIDInvalidateLeftValue = 34
 示例消息:"无效的左值 '%s'"。
 
static final int e_StringIDInvalidBarcodeValue = 103
 示例消息:"无效的条形码值:%s 对于类型为 %s 的条形码是无效值。"。
 
static final int e_StringIDInvalidEnumerate = 67
 示例消息:"无效的枚举值:%s"。
 
static final int e_StringIDInvalidEnumValue = 10
 用于情况的字符串 ID:某些枚举值无效。示例消息:"无效的枚举值:"。
 
static final int e_StringIDInvalidExpression = 32
 示例消息:"无效表达式 '%s'"。
 
static final int e_StringIDInvalidNodeType = 71
 示例消息:"无效的节点类型:'%s'"。
 
static final int e_StringIDInvalidPropertySetOperation = 13
 用于情况的字符串 ID:某些属性设置操作无效。 示例消息:"无效的属性设置操作:"。
 
static final int e_StringIDInvalidToken = 31
 示例消息:"无效标记 '%s'"。
 
static final int e_StringIDIsNotArray = 56
 示例消息:"'%s' 不是数组"。
 
static final int e_StringIDModifyField = 3
 用于情况的字符串 ID:是否修改字段。示例消息:"您是否要修改此字段?"。
 
static final int e_StringIDMonthApril = 84
 用于情况的字符串 ID:使用本地语言的"四月"字符串。
 
static final int e_StringIDMonthAug = 88
 用于情况的字符串 ID:使用本地语言的"八月"字符串。
 
static final int e_StringIDMonthDec = 92
 用于情况的字符串 ID:使用本地语言的"十二月"字符串。
 
static final int e_StringIDMonthFeb = 82
 用于情况的字符串 ID:使用本地语言的"二月"字符串。
 
static final int e_StringIDMonthJan = 81
 用于情况的字符串 ID:使用本地语言的"一月"字符串。
 
static final int e_StringIDMonthJuly = 87
 用于情况的字符串 ID:使用本地语言的"七月"字符串。
 
static final int e_StringIDMonthJune = 86
 用于情况的字符串 ID:使用本地语言的"六月"字符串。
 
static final int e_StringIDMonthMarch = 83
 用于情况的字符串 ID:使用本地语言的"三月"字符串。
 
static final int e_StringIDMonthMay = 85
 用于情况的字符串 ID:使用本地语言的"五月"字符串。
 
static final int e_StringIDMonthNov = 91
 用于情况的字符串 ID:使用本地语言的"十一月"字符串。
 
static final int e_StringIDMonthOct = 90
 用于情况的字符串 ID:使用本地语言的"十月"字符串。
 
static final int e_StringIDMonthSep = 89
 用于情况的字符串 ID:使用本地语言的"九月"字符串。
 
static final int e_StringIDNotAssignObject = 50
 示例消息:"无法直接赋值给对象"。
 
static final int e_StringIDNotDefaultValue = 14
 示例消息:"没有默认属性"。
 
static final int e_StringIDNotFoundConst = 49
 示例消息:"找不到常量 '%s'"。
 
static final int e_StringIDNotFoundContainer = 46
 示例消息:"找不到容器 '%s'"。
 
static final int e_StringIDNotFoundFunction = 55
 示例消息:"找不到函数 '%s'"。
 
static final int e_StringIDNotFoundMethod = 48
 示例消息:"找不到方法 '%s'"。
 
static final int e_StringIDNotFoundProperty = 47
 示例消息:"找不到属性 '%s'"。
 
static final int e_StringIDNotHaveProperty = 70
 示例消息:"'%s' 没有属性 '%s'"。
 
static final int e_StringIDNotModifyField = 4
 用于情况的字符串 ID:不允许修改字段。示例消息:"您不允许修改此字段。"。
 
static final int e_StringIDNotSupportArrayCalculate = 58
 示例消息:"'%s' 操作符不支持数组计算"。
 
static final int e_StringIDNumberOfOccur = 22
 示例消息:"元素 [%s] 违反了其允许的出现次数"。
 
static final int e_StringIDOutOfArrayRange = 57
 示例消息:"超出 '%s' 数组范围"。
 
static final int e_StringIDParametersError = 37
 示例消息:"函数 '%s' 没有 %d 个参数"。
 
static final int e_StringIDRedefinition = 30
 示例消息:"'%s' 重新定义"。
 
static final int e_StringIDScriptArgumentMismatch = 104
 示例消息:"错误:属性或函数参数中的参数不匹配。"。
 
static final int e_StringIDScriptFailedError = 100
 示例消息:"脚本失败(语言是 %s;上下文是 %s)脚本=%s"。
 
static final int e_StringIDScriptInvalidValue = 101
 示例消息:"错误:无效的枚举值:%s"。
 
static final int e_StringIDServerDeny = 73
 用于情况的字符串 ID:服务器拒绝。示例消息:"服务器不允许"。
 
static final int e_StringIDSOMExpectedList = 69
 示例消息:"SOM 表达式在期望单一结果时返回了列表"。
 
static final int e_StringIDSubmitValidateNullError = 102
 示例消息: "至少有一个必填字段为空。请在继续之前填写必填字段(已突出显示)。"。
 
static final int e_StringIDToday = 93
 用于情况的字符串 ID:使用本地语言的"今天"字符串。
 
static final int e_StringIDUnableSetClassName = 23
 示例消息:"无法为属性 'className' 设置值"。
 
static final int e_StringIDUnableSetLanguage = 15
 示例消息:"无法为属性 'language' 设置值"。
 
static final int e_StringIDUnableSetLengthValue = 24
 示例消息:"无法为属性 'length' 设置值"。
 
static final int e_StringIDUnableSetNumPages = 16
 示例消息:"无法为属性 'numPages' 设置值"。
 
static final int e_StringIDUnableSetPlatformValue = 17
 示例消息:"无法为属性 'platform' 设置值"。
 
static final int e_StringIDUnableSetReady = 21
 示例消息:"无法为属性 'ready' 设置值"。
 
static final int e_StringIDUnableSetValidationsEnabledValue = 18
 示例消息:"无法为属性 'validationsEnabled' 设置值"。
 
static final int e_StringIDUnableSetValidationsValue = 19
 示例消息:"无法为属性 'variation' 设置值"。
 
static final int e_StringIDUnableSetVersion = 20
 示例消息:"无法为属性 'version' 设置值"。
 
static final int e_StringIDUnableToSet = 8
 示例消息:"无法设置"。
 
static final int e_StringIDUndefineIdentifier = 33
 示例消息:"未定义的标识符 '%s'"。
 
static final int e_StringIDUnexpectedExpression = 39
 示例消息:"意外的表达式 '%s'"。
 
static final int e_StringIDUnknownCaught = 7
 示例消息:"捕获到未知错误!"。
 
static final int e_StringIDUnsupportChar = 25
 示例消息:"不支持的字符 '%c'"。
 
static final int e_StringIDUnsupportMethod = 11
 示例消息:"不支持的方法 %s。"。
 
static final int e_StringIDUnsupportProperty = 12
 示例消息:"不支持的属性 %s。"。
 
static final int e_StringIDValidateError = 98
 示例消息:"您为 %s 输入的值无效。"。
 
static final int e_StringIDValidateFailed = 1
 示例消息:"验证失败"。
 
static final int e_StringIDValidateLimit = 94
 示例消息:"消息限制已超过。剩余 %d 个验证错误未报告。"。
 
static final int e_StringIDValidateNullError = 96
 示例消息:"%s 不能为空。"。
 
static final int e_StringIDValidateNullWarning = 95
 示例消息:"%s 不能为空。要忽略 %s 的验证,请单击忽略。"。
 
static final int e_StringIDValidateNumberError = 99
 示例消息:"非法值:无法将 '%s' 赋值给 %s。"。
 
static final int e_StringIDValidateOutOfArray = 53
 示例消息:"验证访问索引 '%s' 超出数组范围"。
 
static final int e_StringIDValidateWarning = 97
 示例消息:"您为 %s 输入的值无效。要忽略 %s 的验证,请单击忽略。"。
 
static final int e_StringIDValueExcalmatory = 9
 示例消息:"值!"。
 
static final int e_StringIDViolateBoundary = 72
 示例消息:"元素 [%s] 违反了其允许的出现次数"。
 
static final int e_StringIDWeekDayFri = 79
 用于情况的字符串 ID:使用本地语言的"星期五"字符串。
 
static final int e_StringIDWeekDayMon = 75
 用于情况的字符串 ID:使用本地语言的"星期一"字符串。
 
static final int e_StringIDWeekDaySat = 80
 用于情况的字符串 ID:使用本地语言的"星期六"字符串。
 
static final int e_StringIDWeekDaySun = 74
 用于情况的字符串 ID:使用本地语言的"星期日"字符串。
 
static final int e_StringIDWeekDayThu = 78
 用于情况的字符串 ID:使用本地语言的"星期四"字符串。
 
static final int e_StringIDWeekDayTue = 76
 用于情况的字符串 ID:使用本地语言的"星期二"字符串。
 
static final int e_StringIDWeekDayWed = 77
 用于情况的字符串 ID:使用本地语言的"星期三"字符串。
 

详细描述

此类表示作为 XFA 应用程序提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

成员函数说明

◆ beep()

void com.foxit.sdk.addon.xfa.AppProviderCallback.beep ( int  type)

用于为指定的蜂鸣类型发出蜂鸣声的回调函数。

参数
[in]type蜂鸣类型。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_BeepTypeError 开始的值,这将是这些值之一。
返回
无。

◆ downLoadUrl()

FileReaderCallback com.foxit.sdk.addon.xfa.AppProviderCallback.downLoadUrl ( String  url)

用于从指定 URL 下载的回调函数。

参数
[in]url要下载的 URL。
返回
可用于读取下载结果的 com.foxit.sdk.common.fxcrt.FileReaderCallback 对象。

◆ getAppInfo()

String com.foxit.sdk.addon.xfa.AppProviderCallback.getAppInfo ( int  app_info)

用于获取指定信息类型的应用程序信息的回调函数。

参数
[in]app_info要检索信息的应用程序信息类型。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_AppInfoType 开始的值,这将是 这些值之一。
返回
应用程序信息的字符串。

◆ loadString()

String com.foxit.sdk.addon.xfa.AppProviderCallback.loadString ( int  string_id)

用于为指定情况加载本地语言字符串的回调函数。

此函数对于用户使用本地语言显示指定情况的消息非常有用。 用户可以将示例消息(在从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_StringIDValidateFailed 开始的值 的注释中定义)重写或翻译为指定情况的本地语言, 并将结果字符串返回给 Foxit PDF SDK。 特别地,Foxit PDF SDK 将在示例消息的格式部分添加一些必要的信息/数据, 以使消息更有用。建议用户在重写或翻译的结果字符串中保留这些格式部分; 否则,这些信息/数据将不会丢失,也不会添加到用户提供的消息中。

参数
[in]string_id用于指定情况的字符串 ID。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_StringIDValidateFailed 开始的值,这将是这些值之一。
返回
用于指定情况的字符串。

◆ msgBox()

int com.foxit.sdk.addon.xfa.AppProviderCallback.msgBox ( String  message,
String  title,
int  icon_type,
int  button_type 
)

用于设置消息框的回调函数。

参数
[in]message消息字符串。
[in]title消息框的标题。
[in]icon_type消息框的图标类型。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_MsgBoxIconError 开始的值,这将是这些值之一。
[in]button_type消息框的按钮类型。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_MsgBtnTypeOK 开始的值,这将是这些值之一。
返回
消息框的按钮 ID。请参考从 com.foxit.sdk.addon.xfa.AppProviderCallback.e_MsgBtnIDOK 开始的值,这应该是这些值之一。

◆ postRequestURL()

String com.foxit.sdk.addon.xfa.AppProviderCallback.postRequestURL ( String  url,
String  data,
String  content_type,
String  encode,
String  header 
)

用于将数据发布到给定 URL 的回调函数。

参数
[in]url数据将发布到的 URL。
[in]data要发布的数据。
[in]content_type表示数据内容类型的字符串。此字符串可以是 "text/html"、 "text/xml"、"text/plain"、"multipart/form-data"、"application/x-www-form-urlencoded"、 "application /octet-stream" 或任何有效的 MIME 类型。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何已识别的 [IANA] 字符编码。
[in]header表示要包含在 post 中的任何额外 HTTP 头的字符串。
返回
响应字符串。

◆ putRequestURL()

boolean com.foxit.sdk.addon.xfa.AppProviderCallback.putRequestURL ( String  url,
String  data,
String  encode 
)

用于将数据放置到给定 URL 的回调函数。

参数
[in]url数据将放置到的 URL。
[in]data要放置的数据。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何已识别的 [IANA] 字符编码。
返回
true 表示成功,false 表示失败。

◆ release()

void com.foxit.sdk.addon.xfa.AppProviderCallback.release ( )

用于释放当前回调对象本身的回调函数。

返回
无。

◆ response()

String com.foxit.sdk.addon.xfa.AppProviderCallback.response ( String  question,
String  title,
String  default_answer,
boolean  is_mask 
)

用于响应的回调函数。

参数
[in]question表示问题的字符串。
[in]title表示标题的字符串。
[in]default_answer表示默认答案的字符串。可以是空字符串, 表示没有默认答案。
[in]is_masktrue 表示答案应该用 '*' 掩码, false 表示答案不需要用 '*' 掩码。
返回
表示响应答案的字符串。

◆ showFileDialog()

WStringArray com.foxit.sdk.addon.xfa.AppProviderCallback.showFileDialog ( String  string_title,
String  string_filter,
boolean  is_openfile_dialog 
)

用于显示文件对话框的回调函数。

参数
[in]string_title表示对话框标题的字符串。
[in]string_filter表示对话框文件过滤器的字符串。
[in]is_openfile_dialogtrue 表示对话框是打开文件对话框, false 表示对话框是另存为对话框。
返回
文件路径的数组。