Class Annotations.WidgetAnnotation

Extends Annotations.HTMLAnnotation.
Represents an extendable Widget annotation. These annotations contain a field value

Class Summary
Constructor Attributes	Constructor Name and Description
	Annotations.WidgetAnnotation() Creates a new instance of WidgetAnnotation.

Field Summary
Field Attributes	Field Name and Description
	appearance Gets or sets the widgets current appearance name.
	appearances Gets the appearances of this field (currently keys of an object).
	captions Gets the map of this widget's captions.
	defaultValue Gets or sets the default value of the field associated with the widget annotation.
	fieldFlags Gets the flags object of the field associated with this widget.
	fieldName Gets the name of field associated with the widget annotation.
	flags Gets the flags object on this widget.
	font Gets or sets the font object associated with this widget (defaults to the field's font if not set).
	value Gets or sets the value of the widget annotation (defaults to the field value)

Fields borrowed from class Annotations.HTMLAnnotation:: actions, backgroundColor, border, color, element, hidden, innerElement, rect, rotation
Fields borrowed from class Annotations.Annotation:: Author, Custom, DateModified, elementName, Height, Hidden, Id, IsAdded, IsDeleted, IsModified, Listable, NoMove, NoResize, NoRotate, NoZoom, PageNumber, Subject, Width, X, Y

Method Summary
Method Attributes	Method Name and Description
	commit() Commits the current widget value to the associated field.
	getValue() Get the widget's value.
	refresh() Refreshes the styles, and it there is any auto-sized text, the text sizing of the widget,
	set(options) Set all properties on this widget.
	setValue(value) Set and format the widget's value.
	setVisible(visible) Set whether the widget is visible.

Methods borrowed from class Annotations.Annotation:: adjustRect, deserialize, draw, getBottom, getContents, getCustom, getFlag, getHeight, getLeft, getPageNumber, getRect, getRectPadding, getReplies, getRight, getTop, getWidth, getX, getY, isReply, render, resize, serialize, setContents, setCustom, setFlag, setHeight, setPageNumber, setRect, setWidth, setX, setY, unrender
Methods borrowed from class Actions.Dispatcher:: addAction, addActions, addActionsFromXfdf, getActions, getDocumentViewer, saveActionsToXfdf, setDocumentViewer, triggerAction

Class Detail

Annotations.WidgetAnnotation()

Creates a new instance of WidgetAnnotation.

Field Detail

{string} appearance

Gets or sets the widgets current appearance name.

{object} appearances

Gets the appearances of this field (currently keys of an object).

{object} captions

Gets the map of this widget's captions. (Normal is used for the face of PushButtonAnnotations)

{?(string|number)} defaultValue

Gets or sets the default value of the field associated with the widget annotation.

{Annotations.WidgetFlags} fieldFlags

Gets the flags object of the field associated with this widget.

{string} fieldName

Gets the name of field associated with the widget annotation.

{Annotations.WidgetFlags} flags

Gets the flags object on this widget.

{Annotations.Font} font

Gets or sets the font object associated with this widget (defaults to the field's font if not set).

{?(string|number)} value

Gets or sets the value of the widget annotation (defaults to the field value)

Method Detail

commit()

Commits the current widget value to the associated field.

{?(string|number)} getValue()

Get the widget's value.

refresh()

Refreshes the styles, and it there is any auto-sized text, the text sizing of the widget,

set(options)

Set all properties on this widget.

Parameters:
{(Annotations.WidgetAnnotation|Annotations.WidgetSpec)} options: The set of parameters to set

setValue(value)

Set and format the widget's value.

setVisible(visible)

Set whether the widget is visible.

WebViewer HTML5 API Reference v2.2.1.49322