net.bitform.api.secure

Class SecureOptions.Fields

java.lang.Object

net.bitform.api.options.OptionContainer

net.bitform.api.secure.SecureOptions.Fields

Enclosing class:

SecureOptions

public static final class SecureOptions.Fields
extends OptionContainer

A container for Microsoft Word fields. Each field includes options that allow scrubbing and modification of that field.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecureOptions.Fields.Action Action
static class	SecureOptions.Fields.Field Deafult the class for the items
static class	SecureOptions.Fields.StringField

Field Summary

Fields

Modifier and Type	Field and Description
static SecureOptions.Fields.StringField	AddressBlock
static SecureOptions.Fields.StringField	Advance
static SecureOptions.Fields.StringField	Ask
static SecureOptions.Fields.StringField	Author
static SecureOptions.Fields.StringField	AutoNum
static SecureOptions.Fields.StringField	AutoNumLgl
static SecureOptions.Fields.StringField	AutoNumOut
static SecureOptions.Fields.StringField	AutoText
static SecureOptions.Fields.StringField	AutoTextList
static SecureOptions.Fields.StringField	BarCode
static SecureOptions.Fields.StringField	Bibliography
static SecureOptions.Fields.StringField	BidiOutline
static SecureOptions.Fields.StringField	Citation
static SecureOptions.Fields.StringField	Comments
static SecureOptions.Fields.StringField	Compare
static SecureOptions.Fields.StringField	CreateDate
static SecureOptions.Fields.StringField	Database
static SecureOptions.Fields.StringField	Date
static SecureOptions.Fields.Action	defaultAction Default action
static SecureOptions.Fields.StringField	DocProperty
static SecureOptions.Fields.StringField	DocVariable
static SecureOptions.Fields.StringField	EditTime
static SecureOptions.Fields.StringField	Eq
static SecureOptions.Fields.StringField	FileName
static SecureOptions.Fields.StringField	FileSize
static SecureOptions.Fields.StringField	FillIn
static SecureOptions.Fields.StringField	Formula
static SecureOptions.Fields.StringField	GoToButton
static SecureOptions.Fields.StringField	GreetingLine
static SecureOptions.Fields.StringField	Hyperlink
static SecureOptions.Fields.StringField	If
static SecureOptions.Fields.StringField	ImplicitRef
static SecureOptions.Fields.StringField	IncludePicture
static SecureOptions.Fields.StringField	IncludeText
static SecureOptions.Fields.StringField	Index
static SecureOptions.Fields.StringField	Info
static SecureOptions.Fields.StringField	Keywords
static SecureOptions.Fields.StringField	LastSavedBy
static SecureOptions.Fields.StringField	Link
static SecureOptions.Fields.StringField	ListNum
static SecureOptions.Fields.StringField	MacroButton
static SecureOptions.Fields.StringField	MergeField
static SecureOptions.Fields.StringField	MergeRec
static SecureOptions.Fields.StringField	MergeSeq
static SecureOptions.Fields.StringField	Next
static SecureOptions.Fields.StringField	NextIf
static SecureOptions.Fields.StringField	NoteRef
static SecureOptions.Fields.StringField	NumChars
static SecureOptions.Fields.StringField	NumPages
static SecureOptions.Fields.StringField	NumWords
static SecureOptions.Fields.StringField	Page
static SecureOptions.Fields.StringField	PageRef
static SecureOptions.Fields.StringField	Print
static SecureOptions.Fields.StringField	PrintDate
static SecureOptions.Fields.StringField	Private
static SecureOptions.Fields.StringField	Quote
static SecureOptions.Fields.StringField	RD
static SecureOptions.Fields.StringField	Ref
static SecureOptions.Fields.StringField	RevNum
static SecureOptions.Fields.StringField	SaveDate
static SecureOptions.Fields.StringField	Section
static SecureOptions.Fields.StringField	SectionPages
static SecureOptions.Fields.StringField	Seq
static SecureOptions.Fields.StringField	Set
static SecureOptions.Fields.StringField	SkipIf
static SecureOptions.Fields.StringField	StyleRef
static SecureOptions.Fields.StringField	Subject
static SecureOptions.Fields.StringField	Symbol
static SecureOptions.Fields.StringField	TA
static SecureOptions.Fields.StringField	TC
static SecureOptions.Fields.StringField	Template
static SecureOptions.Fields.StringField	Time
static SecureOptions.Fields.StringField	Title
static SecureOptions.Fields.StringField	TOA
static SecureOptions.Fields.StringField	TOC
static SecureOptions.Fields.StringField	Unknown
static SecureOptions.Fields.StringField	UserAddress
static SecureOptions.Fields.StringField	UserInitials
static SecureOptions.Fields.StringField	UserName
static SecureOptions.Fields.StringField	XE

Method Summary

Modifier and Type	Method and Description
OptionContainer[]	getAllContainers() Get all the option containers in this container
static SecureOptions.Fields.Field[]	getAllFields()
Option[]	getAllOptions() Gets all the options in this container
static SecureOptions.Fields.Field	mapFieldExtraId(int id)
static SecureOptions.Fields.Field	mapFieldId(int id)
Option	mapOptionId(int id) Maps an integer id of an option in this list to the option itself.
Option	mapOptionId(java.lang.String id) Maps an string id of an option in this list to the option itself.

Methods inherited from class net.bitform.api.options.OptionContainer

getId, writeXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

defaultAction

public static final SecureOptions.Fields.Action defaultAction

Default action

AddressBlock

public static final SecureOptions.Fields.StringField AddressBlock

Advance

public static final SecureOptions.Fields.StringField Advance

Ask

public static final SecureOptions.Fields.StringField Ask

Author

public static final SecureOptions.Fields.StringField Author

AutoNum

public static final SecureOptions.Fields.StringField AutoNum

AutoNumLgl

public static final SecureOptions.Fields.StringField AutoNumLgl

AutoNumOut

public static final SecureOptions.Fields.StringField AutoNumOut

AutoText

public static final SecureOptions.Fields.StringField AutoText

AutoTextList

public static final SecureOptions.Fields.StringField AutoTextList

BarCode

public static final SecureOptions.Fields.StringField BarCode

Bibliography

public static final SecureOptions.Fields.StringField Bibliography

BidiOutline

public static final SecureOptions.Fields.StringField BidiOutline

Citation

public static final SecureOptions.Fields.StringField Citation

Comments

public static final SecureOptions.Fields.StringField Comments

Compare

public static final SecureOptions.Fields.StringField Compare

CreateDate

public static final SecureOptions.Fields.StringField CreateDate

Database

public static final SecureOptions.Fields.StringField Database

Date

public static final SecureOptions.Fields.StringField Date

DocProperty

public static final SecureOptions.Fields.StringField DocProperty

DocVariable

public static final SecureOptions.Fields.StringField DocVariable

EditTime

public static final SecureOptions.Fields.StringField EditTime

Eq

public static final SecureOptions.Fields.StringField Eq

FileName

public static final SecureOptions.Fields.StringField FileName

FileSize

public static final SecureOptions.Fields.StringField FileSize

FillIn

public static final SecureOptions.Fields.StringField FillIn

Formula

public static final SecureOptions.Fields.StringField Formula

GoToButton

public static final SecureOptions.Fields.StringField GoToButton

GreetingLine

public static final SecureOptions.Fields.StringField GreetingLine

Hyperlink

public static final SecureOptions.Fields.StringField Hyperlink

If

public static final SecureOptions.Fields.StringField If

ImplicitRef

public static final SecureOptions.Fields.StringField ImplicitRef

IncludePicture

public static final SecureOptions.Fields.StringField IncludePicture

IncludeText

public static final SecureOptions.Fields.StringField IncludeText

Index

public static final SecureOptions.Fields.StringField Index

Info

public static final SecureOptions.Fields.StringField Info

Keywords

public static final SecureOptions.Fields.StringField Keywords

LastSavedBy

public static final SecureOptions.Fields.StringField LastSavedBy

Link

public static final SecureOptions.Fields.StringField Link

ListNum

public static final SecureOptions.Fields.StringField ListNum

MacroButton

public static final SecureOptions.Fields.StringField MacroButton

MergeField

public static final SecureOptions.Fields.StringField MergeField

MergeRec

public static final SecureOptions.Fields.StringField MergeRec

MergeSeq

public static final SecureOptions.Fields.StringField MergeSeq

Next

public static final SecureOptions.Fields.StringField Next

NextIf

public static final SecureOptions.Fields.StringField NextIf

NoteRef

public static final SecureOptions.Fields.StringField NoteRef

NumChars

public static final SecureOptions.Fields.StringField NumChars

NumPages

public static final SecureOptions.Fields.StringField NumPages

NumWords

public static final SecureOptions.Fields.StringField NumWords

Page

public static final SecureOptions.Fields.StringField Page

PageRef

public static final SecureOptions.Fields.StringField PageRef

Print

public static final SecureOptions.Fields.StringField Print

PrintDate

public static final SecureOptions.Fields.StringField PrintDate

Private

public static final SecureOptions.Fields.StringField Private

Quote

public static final SecureOptions.Fields.StringField Quote

RD

public static final SecureOptions.Fields.StringField RD

Ref

public static final SecureOptions.Fields.StringField Ref

RevNum

public static final SecureOptions.Fields.StringField RevNum

SaveDate

public static final SecureOptions.Fields.StringField SaveDate

Section

public static final SecureOptions.Fields.StringField Section

SectionPages

public static final SecureOptions.Fields.StringField SectionPages

Seq

public static final SecureOptions.Fields.StringField Seq

Set

public static final SecureOptions.Fields.StringField Set

SkipIf

public static final SecureOptions.Fields.StringField SkipIf

StyleRef

public static final SecureOptions.Fields.StringField StyleRef

Subject

public static final SecureOptions.Fields.StringField Subject

Symbol

public static final SecureOptions.Fields.StringField Symbol

TA

public static final SecureOptions.Fields.StringField TA

TC

public static final SecureOptions.Fields.StringField TC

Template

public static final SecureOptions.Fields.StringField Template

Time

public static final SecureOptions.Fields.StringField Time

Title

public static final SecureOptions.Fields.StringField Title

TOA

public static final SecureOptions.Fields.StringField TOA

TOC

public static final SecureOptions.Fields.StringField TOC

UserAddress

public static final SecureOptions.Fields.StringField UserAddress

UserInitials

public static final SecureOptions.Fields.StringField UserInitials

UserName

public static final SecureOptions.Fields.StringField UserName

XE

public static final SecureOptions.Fields.StringField XE

Unknown

public static final SecureOptions.Fields.StringField Unknown

Method Detail

getAllFields

public static SecureOptions.Fields.Field[] getAllFields()

getAllContainers

public OptionContainer[] getAllContainers()

Description copied from class: OptionContainer

Get all the option containers in this container

Specified by:

getAllContainers in class OptionContainer

Returns:

an array containing all the containers

mapFieldId

public static SecureOptions.Fields.Field mapFieldId(int id)

mapFieldExtraId

public static SecureOptions.Fields.Field mapFieldExtraId(int id)

getAllOptions

public Option[] getAllOptions()

Description copied from class: OptionContainer

Gets all the options in this container

Specified by:

getAllOptions in class OptionContainer

Returns:

an array containing all the requested options

mapOptionId

public Option mapOptionId(java.lang.String id)

Description copied from class: OptionContainer

Maps an string id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found

mapOptionId

public Option mapOptionId(int id)

Description copied from class: OptionContainer

Maps an integer id of an option in this list to the option itself. This is likely faster than getting all the options and enumerating/testing them.

Specified by:

mapOptionId in class OptionContainer

Parameters:

id - The unique string identifier for an option

Returns:

The option if it exists in this list or null if it cannot be found