Package | com.adobe.incopy |
Class | public class PlaceGun |
Inheritance | PlaceGun ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
buttons : Buttons [read-only]
A collection of buttons. | PlaceGun | ||
epss : EPSs [read-only]
A collection of EPS files. | PlaceGun | ||
epstexts : EPSTexts [read-only]
EPSTexts
| PlaceGun | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | PlaceGun | ||
events : Events [override] [read-only]
A collection of events. | PlaceGun | ||
formFields : FormFields [read-only]
A collection of form fields. | PlaceGun | ||
graphicLines : GraphicLines [read-only]
A collection of graphic lines. | PlaceGun | ||
graphics : Graphics [read-only]
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). | PlaceGun | ||
groups : Groups [read-only]
A collection of groups. | PlaceGun | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
images : Images [read-only]
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). | PlaceGun | ||
importedPages : ImportedPages [read-only]
Imported InDesign pages. | PlaceGun | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | PlaceGun | ||
loaded : Boolean [read-only]
Whether the place gun is currently loaded with content for placing. | PlaceGun | ||
multiStateObjects : MultiStateObjects [read-only]
A collection of multi-state objects. | PlaceGun | ||
ovals : Ovals [read-only]
A collection of ellipses. | PlaceGun | ||
pageItems : PageItems [read-only]
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. | PlaceGun | ||
parent : Object [override] [read-only]
The parent of the PlaceGun (a Document). | PlaceGun | ||
pdfs : PDFs [read-only]
A collection of PDF files. | PlaceGun | ||
picts : PICTs [read-only]
A collection of PICT graphics. | PlaceGun | ||
polygons : Polygons [read-only]
A collection of polygons. | PlaceGun | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | PlaceGun | ||
rectangles : Rectangles [read-only]
A collection of rectangles. | PlaceGun | ||
splineItems : SplineItems [read-only]
The spline items collection. | PlaceGun | ||
textFrames : TextFrames [read-only]
A collection of text frames. | PlaceGun | ||
wmfs : WMFs [read-only]
A collection of WMF graphics. | PlaceGun |
Method | Defined By | ||
---|---|---|---|
abortPlaceGun():void
Delete the contents of the place gun. | PlaceGun | ||
addEventListenerPlaceGun(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | PlaceGun | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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. | PlaceGun | ||
![]() | 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 | |
loadPlaceGun(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void
Load the place gun with one or more files. | PlaceGun | ||
removeEventListenerPlaceGun(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | PlaceGun | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
rotate(directionParam:RotationDirection = null):void
Rotate the contents of the place gun. | PlaceGun | ||
toSpecifier():String [override]
Retrieves the object specifier. | PlaceGun | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
buttons | property |
buttons:Buttons
[read-only] Since : | CS5 |
A collection of buttons.
public function get buttons():Buttons
epss | property |
epss:EPSs
[read-only] Since : | CS5 |
A collection of EPS files.
public function get epss():EPSs
epstexts | property |
epstexts:EPSTexts
[read-only] Since : | CS5 |
EPSTexts
public function get epstexts():EPSTexts
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
formFields | property |
formFields:FormFields
[read-only] Since : | CS5 |
A collection of form fields.
public function get formFields():FormFields
graphicLines | property |
graphicLines:GraphicLines
[read-only] Since : | CS5 |
A collection of graphic lines.
public function get graphicLines():GraphicLines
graphics | property |
graphics:Graphics
[read-only] Since : | CS5 |
A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
public function get graphics():Graphics
groups | property |
groups:Groups
[read-only] Since : | CS5 |
A collection of groups.
public function get groups():Groups
images | property |
images:Images
[read-only] Since : | CS5 |
A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
public function get images():Images
importedPages | property |
importedPages:ImportedPages
[read-only] Since : | CS5 |
Imported InDesign pages.
public function get importedPages():ImportedPages
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
loaded | property |
loaded:Boolean
[read-only] Since : | CS5 |
Whether the place gun is currently loaded with content for placing.
public function get loaded():Boolean
multiStateObjects | property |
multiStateObjects:MultiStateObjects
[read-only] Since : | CS5 |
A collection of multi-state objects.
public function get multiStateObjects():MultiStateObjects
ovals | property |
ovals:Ovals
[read-only] Since : | CS5 |
A collection of ellipses.
public function get ovals():Ovals
pageItems | property |
pageItems:PageItems
[read-only] Since : | CS5 |
The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
public function get pageItems():PageItems
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the PlaceGun (a Document).
public function get parent():Object
pdfs | property |
pdfs:PDFs
[read-only] Since : | CS5 |
A collection of PDF files.
public function get pdfs():PDFs
picts | property |
picts:PICTs
[read-only] Since : | CS5 |
A collection of PICT graphics.
public function get picts():PICTs
polygons | property |
polygons:Polygons
[read-only] Since : | CS5 |
A collection of polygons.
public function get polygons():Polygons
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
rectangles | property |
rectangles:Rectangles
[read-only] Since : | CS5 |
A collection of rectangles.
public function get rectangles():Rectangles
splineItems | property |
splineItems:SplineItems
[read-only] Since : | CS5 |
The spline items collection.
public function get splineItems():SplineItems
textFrames | property |
textFrames:TextFrames
[read-only] Since : | CS5 |
A collection of text frames.
public function get textFrames():TextFrames
wmfs | property |
wmfs:WMFs
[read-only] Since : | CS5 |
A collection of WMF graphics.
public function get wmfs():WMFs
abortPlaceGun | () | method |
public function abortPlaceGun():void
Since : | CS5 |
Delete the contents of the place gun.
addEventListenerPlaceGun | () | method |
public function addEventListenerPlaceGun(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 |
loadPlaceGun | () | method |
public function loadPlaceGun(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void
Since : | CS5 |
Load the place gun with one or more files.
Parameters
fileNameParam:Object (default = null ) — (Object) One or more files to place. Can accept: File or Array of Files.
| |
showingOptionsParam:Boolean (default = false ) — (Boolean) Whether to display the import options dialog (Optional)
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the placed object(s) (Optional)
|
removeEventListenerPlaceGun | () | method |
public function removeEventListenerPlaceGun(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 |
rotate | () | method |
public function rotate(directionParam:RotationDirection = null):void
Since : | CS5 |
Rotate the contents of the place gun.
Parameters
directionParam:RotationDirection (default = null ) — (RotationDirection) Which direction to rotate the contents (Optional)
|
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |