Packagecom.adobe.indesign
Classpublic class IntegerEditbox
InheritanceIntegerEditbox Inheritance Widget Inheritance CSHostObject Inheritance flash.utils.Proxy

Widget



Public Properties
 PropertyDefined By
  editContents : String
The default value in an editbox control.
IntegerEditbox
  editValue : Number
The real number default value of the editbox or combobox.
IntegerEditbox
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
IntegerEditbox
  events : Events
[override] [read-only] A collection of events.
IntegerEditbox
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[override] [read-only] The unique ID of the IntegerEditbox.
IntegerEditbox
  index : Number
[override] [read-only] The index of the IntegerEditbox within its containing object.
IntegerEditbox
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
IntegerEditbox
  largeNudge : Number
The amount to increment/decrement the value when a user selects the control and holds down the Shift key while pressing an arrow key on the keyboard.
IntegerEditbox
  maximumValue : Number
The maximum value that a user is allowed to type in a numeric editbox or combobox.
IntegerEditbox
  minimumValue : Number
The minumim value that a user is allowed to type in a numeric editbox or combobox.
IntegerEditbox
  minWidth : Number
[override] The width of the control.
IntegerEditbox
  parent : Object
[override] [read-only] The parent of the IntegerEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
IntegerEditbox
  properties : Object
[override] A property that allows setting of several properties at the same time.
IntegerEditbox
  smallNudge : Number
The amount to increment/decrement the value when the user selects the control and presses an arrow key on the keyboard.
IntegerEditbox
Public Methods
 MethodDefined By
  
addEventListenerIntegerEditbox(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
IntegerEditbox
 Inherited
addEventListenerWidget(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Widget
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
[override] Resolves the object specifier, creating an array of object references.
IntegerEditbox
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
removeEventListenerIntegerEditbox(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
IntegerEditbox
 Inherited
removeEventListenerWidget(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Widget
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
IntegerEditbox
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
editContentsproperty
editContents:String

The default value in an editbox control. Note: Do not specify both edit contents and edit value. If both are specified, the one that occurs later in the script is used.


Implementation
    public function get editContents():String
    public function set editContents(value:String):void
editValueproperty 
editValue:Number

The real number default value of the editbox or combobox. Note: For measurement controls, the value is interpreted in points. The points value is converted to edit units when the dialog opens. Note: Do not specify both edit value and edit contents. If both are specified, the one that occurs later in the script is used.


Implementation
    public function get editValue():Number
    public function set editValue(value:Number):void
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
idproperty 
id:Number  [read-only] [override]

The unique ID of the IntegerEditbox.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only] [override]

The index of the IntegerEditbox within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
largeNudgeproperty 
largeNudge:Number

The amount to increment/decrement the value when a user selects the control and holds down the Shift key while pressing an arrow key on the keyboard.


Implementation
    public function get largeNudge():Number
    public function set largeNudge(value:Number):void
maximumValueproperty 
maximumValue:Number

The maximum value that a user is allowed to type in a numeric editbox or combobox. Note: The value for a measurement editbox or combobox is interpreted in points, regardless of the edit units specified for the control. The points value is converted automatically to the edit unit when the dialog is opened.


Implementation
    public function get maximumValue():Number
    public function set maximumValue(value:Number):void
minimumValueproperty 
minimumValue:Number

The minumim value that a user is allowed to type in a numeric editbox or combobox. Note: The value for a measurement editbox or combobox is interpreted in points, regardless of the edit units specified for the control. The points value is converted automatically to the edit unit when the dialog is opened.


Implementation
    public function get minimumValue():Number
    public function set minimumValue(value:Number):void
minWidthproperty 
minWidth:Number[override]

The width of the control. For an editbox or combobox, specifies the minimum width of the box.


Implementation
    public function get minWidth():Number
    public function set minWidth(value:Number):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the IntegerEditbox (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
smallNudgeproperty 
smallNudge:Number

The amount to increment/decrement the value when the user selects the control and presses an arrow key on the keyboard.


Implementation
    public function get smallNudge():Number
    public function set smallNudge(value:Number):void
Method Detail
addEventListenerIntegerEditbox()method
public function addEventListenerIntegerEditbox(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
getElements()method 
override public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
removeEventListenerIntegerEditbox()method 
public function removeEventListenerIntegerEditbox(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String