Packagecom.adobe.indesign
Classpublic class PlaceGun
InheritancePlaceGun Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
  snippets : Snippets
[read-only] A collection of IDML snippets.
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
Public Methods
 MethodDefined By
  
Delete the contents of the place gun.
PlaceGun
  
addEventListenerPlaceGun(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
PlaceGun
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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.
PlaceGun
 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
  
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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
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
 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
buttonsproperty
buttons:Buttons  [read-only]

A collection of buttons.


Implementation
    public function get buttons():Buttons
epssproperty 
epss:EPSs  [read-only]

A collection of EPS files.


Implementation
    public function get epss():EPSs
epstextsproperty 
epstexts:EPSTexts  [read-only]

EPSTexts


Implementation
    public function get epstexts():EPSTexts
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
formFieldsproperty 
formFields:FormFields  [read-only]

A collection of form fields.


Implementation
    public function get formFields():FormFields
graphicLinesproperty 
graphicLines:GraphicLines  [read-only]

A collection of graphic lines.


Implementation
    public function get graphicLines():GraphicLines
graphicsproperty 
graphics:Graphics  [read-only]

A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).


Implementation
    public function get graphics():Graphics
groupsproperty 
groups:Groups  [read-only]

A collection of groups.


Implementation
    public function get groups():Groups
imagesproperty 
images:Images  [read-only]

A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).


Implementation
    public function get images():Images
importedPagesproperty 
importedPages:ImportedPages  [read-only]

Imported InDesign pages.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
loadedproperty 
loaded:Boolean  [read-only]

Whether the place gun is currently loaded with content for placing.


Implementation
    public function get loaded():Boolean
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
ovalsproperty 
ovals:Ovals  [read-only]

A collection of ellipses.


Implementation
    public function get ovals():Ovals
pageItemsproperty 
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.


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

The parent of the PlaceGun (a Document).


Implementation
    public function get parent():Object
pdfsproperty 
pdfs:PDFs  [read-only]

A collection of PDF files.


Implementation
    public function get pdfs():PDFs
pictsproperty 
picts:PICTs  [read-only]

A collection of PICT graphics.


Implementation
    public function get picts():PICTs
polygonsproperty 
polygons:Polygons  [read-only]

A collection of polygons.


Implementation
    public function get polygons():Polygons
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
rectanglesproperty 
rectangles:Rectangles  [read-only]

A collection of rectangles.


Implementation
    public function get rectangles():Rectangles
snippetsproperty 
snippets:Snippets  [read-only]

A collection of IDML snippets.


Implementation
    public function get snippets():Snippets
splineItemsproperty 
splineItems:SplineItems  [read-only]

The spline items collection.


Implementation
    public function get splineItems():SplineItems
textFramesproperty 
textFrames:TextFrames  [read-only]

A collection of text frames.


Implementation
    public function get textFrames():TextFrames
wmfsproperty 
wmfs:WMFs  [read-only]

A collection of WMF graphics.


Implementation
    public function get wmfs():WMFs
Method Detail
abortPlaceGun()method
public function abortPlaceGun():void

Delete the contents of the place gun.

addEventListenerPlaceGun()method 
public function addEventListenerPlaceGun(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
loadPlaceGun()method 
public function loadPlaceGun(fileNameParam:Object = null, showingOptionsParam:Boolean = false, withPropertiesParam:Object = null):void

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

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
rotate()method 
public function rotate(directionParam:RotationDirection = null):void

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

Retrieves the object specifier.

Returns
String