Packagecom.adobe.indesign
Classpublic class WatermarkPreference
InheritanceWatermarkPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
WatermarkPreference
  events : Events
[override] [read-only] A collection of events.
WatermarkPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
WatermarkPreference
  parent : Object
[override] [read-only] The parent of the WatermarkPreference (a Document or Application).
WatermarkPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
WatermarkPreference
  watermarkDoPrint : Boolean
Watermark do print for a document
WatermarkPreference
  watermarkDrawInBack : Boolean
Watermark draw in back for a document
WatermarkPreference
  watermarkFontColor : Object
Watermark font color for a document.
WatermarkPreference
  watermarkFontFamily : String
Watermark font family display name
WatermarkPreference
  watermarkFontPointSize : Number
Watermark font point size for a document
WatermarkPreference
  watermarkFontStyle : String
Watermark font style name
WatermarkPreference
  watermarkHorizontalOffset : Object
Watermark horizontal offset for a document
WatermarkPreference
  watermarkHorizontalPosition : WatermarkHorizontalPositionEnum
Watermark horizontal position enum for a document
WatermarkPreference
  watermarkOpacity : Number
Watermark opacity (as a percentage).
WatermarkPreference
  watermarkRotation : Number
Watermark rotation for a document
WatermarkPreference
  watermarkText : String
Watermark text for a document
WatermarkPreference
  watermarkVerticalOffset : Object
Watermark vertical offset for a document
WatermarkPreference
  watermarkVerticalPosition : WatermarkVerticalPositionEnum
Watermark vertical position enum for a document
WatermarkPreference
  watermarkVisibility : Boolean
Watermark visibility for a document
WatermarkPreference
Public Methods
 MethodDefined By
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
  
addEventListenerWatermarkPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
WatermarkPreference
 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.
WatermarkPreference
 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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
  
removeEventListenerWatermarkPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
WatermarkPreference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
WatermarkPreference
 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
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
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the WatermarkPreference (a Document or Application).


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
watermarkDoPrintproperty 
watermarkDoPrint:Boolean

Watermark do print for a document


Implementation
    public function get watermarkDoPrint():Boolean
    public function set watermarkDoPrint(value:Boolean):void
watermarkDrawInBackproperty 
watermarkDrawInBack:Boolean

Watermark draw in back for a document


Implementation
    public function get watermarkDrawInBack():Boolean
    public function set watermarkDrawInBack(value:Boolean):void
watermarkFontColorproperty 
watermarkFontColor:Object

Watermark font color for a document. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.


Implementation
    public function get watermarkFontColor():Object
    public function set watermarkFontColor(value:Object):void
watermarkFontFamilyproperty 
watermarkFontFamily:String

Watermark font family display name


Implementation
    public function get watermarkFontFamily():String
    public function set watermarkFontFamily(value:String):void
watermarkFontPointSizeproperty 
watermarkFontPointSize:Number

Watermark font point size for a document


Implementation
    public function get watermarkFontPointSize():Number
    public function set watermarkFontPointSize(value:Number):void
watermarkFontStyleproperty 
watermarkFontStyle:String

Watermark font style name


Implementation
    public function get watermarkFontStyle():String
    public function set watermarkFontStyle(value:String):void
watermarkHorizontalOffsetproperty 
watermarkHorizontalOffset:Object

Watermark horizontal offset for a document


Implementation
    public function get watermarkHorizontalOffset():Object
    public function set watermarkHorizontalOffset(value:Object):void
watermarkHorizontalPositionproperty 
watermarkHorizontalPosition:WatermarkHorizontalPositionEnum

Watermark horizontal position enum for a document


Implementation
    public function get watermarkHorizontalPosition():WatermarkHorizontalPositionEnum
    public function set watermarkHorizontalPosition(value:WatermarkHorizontalPositionEnum):void
watermarkOpacityproperty 
watermarkOpacity:Number

Watermark opacity (as a percentage). (Range: 0 to 100)


Implementation
    public function get watermarkOpacity():Number
    public function set watermarkOpacity(value:Number):void
watermarkRotationproperty 
watermarkRotation:Number

Watermark rotation for a document


Implementation
    public function get watermarkRotation():Number
    public function set watermarkRotation(value:Number):void
watermarkTextproperty 
watermarkText:String

Watermark text for a document


Implementation
    public function get watermarkText():String
    public function set watermarkText(value:String):void
watermarkVerticalOffsetproperty 
watermarkVerticalOffset:Object

Watermark vertical offset for a document


Implementation
    public function get watermarkVerticalOffset():Object
    public function set watermarkVerticalOffset(value:Object):void
watermarkVerticalPositionproperty 
watermarkVerticalPosition:WatermarkVerticalPositionEnum

Watermark vertical position enum for a document


Implementation
    public function get watermarkVerticalPosition():WatermarkVerticalPositionEnum
    public function set watermarkVerticalPosition(value:WatermarkVerticalPositionEnum):void
watermarkVisibilityproperty 
watermarkVisibility:Boolean

Watermark visibility for a document


Implementation
    public function get watermarkVisibility():Boolean
    public function set watermarkVisibility(value:Boolean):void
Method Detail
addEventListenerWatermarkPreference()method
public function addEventListenerWatermarkPreference(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
removeEventListenerWatermarkPreference()method 
public function removeEventListenerWatermarkPreference(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