Package | com.adobe.indesign |
Class | public class WatermarkPreference |
Inheritance | WatermarkPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | WatermarkPreference | ||
events : Events [override] [read-only]
A collection of events. | WatermarkPreference | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
![]() | 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 | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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 | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 | |
![]() | 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 | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | WatermarkPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the WatermarkPreference (a Document or Application).
public function get parent():Object
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
watermarkDoPrint | property |
watermarkDoPrint:Boolean
Since : | CS5 |
Watermark do print for a document
public function get watermarkDoPrint():Boolean
public function set watermarkDoPrint(value:Boolean):void
watermarkDrawInBack | property |
watermarkDrawInBack:Boolean
Since : | CS5 |
Watermark draw in back for a document
public function get watermarkDrawInBack():Boolean
public function set watermarkDrawInBack(value:Boolean):void
watermarkFontColor | property |
watermarkFontColor:Object
Since : | CS5 |
Watermark font color for a document. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator.
public function get watermarkFontColor():Object
public function set watermarkFontColor(value:Object):void
watermarkFontFamily | property |
watermarkFontFamily:String
Since : | CS5 |
Watermark font family display name
public function get watermarkFontFamily():String
public function set watermarkFontFamily(value:String):void
watermarkFontPointSize | property |
watermarkFontPointSize:Number
Since : | CS5 |
Watermark font point size for a document
public function get watermarkFontPointSize():Number
public function set watermarkFontPointSize(value:Number):void
watermarkFontStyle | property |
watermarkFontStyle:String
Since : | CS5 |
Watermark font style name
public function get watermarkFontStyle():String
public function set watermarkFontStyle(value:String):void
watermarkHorizontalOffset | property |
watermarkHorizontalOffset:Object
Since : | CS5 |
Watermark horizontal offset for a document
public function get watermarkHorizontalOffset():Object
public function set watermarkHorizontalOffset(value:Object):void
watermarkHorizontalPosition | property |
watermarkHorizontalPosition:WatermarkHorizontalPositionEnum
Since : | CS5 |
Watermark horizontal position enum for a document
public function get watermarkHorizontalPosition():WatermarkHorizontalPositionEnum
public function set watermarkHorizontalPosition(value:WatermarkHorizontalPositionEnum):void
watermarkOpacity | property |
watermarkOpacity:Number
Since : | CS5 |
Watermark opacity (as a percentage). (Range: 0 to 100)
public function get watermarkOpacity():Number
public function set watermarkOpacity(value:Number):void
watermarkRotation | property |
watermarkRotation:Number
Since : | CS5 |
Watermark rotation for a document
public function get watermarkRotation():Number
public function set watermarkRotation(value:Number):void
watermarkText | property |
watermarkText:String
Since : | CS5 |
Watermark text for a document
public function get watermarkText():String
public function set watermarkText(value:String):void
watermarkVerticalOffset | property |
watermarkVerticalOffset:Object
Since : | CS5 |
Watermark vertical offset for a document
public function get watermarkVerticalOffset():Object
public function set watermarkVerticalOffset(value:Object):void
watermarkVerticalPosition | property |
watermarkVerticalPosition:WatermarkVerticalPositionEnum
Since : | CS5 |
Watermark vertical position enum for a document
public function get watermarkVerticalPosition():WatermarkVerticalPositionEnum
public function set watermarkVerticalPosition(value:WatermarkVerticalPositionEnum):void
watermarkVisibility | property |
watermarkVisibility:Boolean
Since : | CS5 |
Watermark visibility for a document
public function get watermarkVisibility():Boolean
public function set watermarkVisibility(value:Boolean):void
addEventListenerWatermarkPreference | () | method |
public function addEventListenerWatermarkPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerWatermarkPreference | () | method |
public function removeEventListenerWatermarkPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |