Packagecom.adobe.indesign
Classpublic class Snippet
InheritanceSnippet Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  BEFORE_PLACE : String
[static] [read-only] Dispatched before a Snippet is placed.
Snippet
  buttons : Buttons
[read-only] A collection of buttons.
Snippet
  epss : EPSs
[read-only] A collection of EPS files.
Snippet
  epstexts : EPSTexts
[read-only] EPSTexts
Snippet
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Snippet
  events : Events
[read-only] A collection of events.
Snippet
  formFields : FormFields
[read-only] A collection of form fields.
Snippet
  graphicLines : GraphicLines
[read-only] A collection of graphic lines.
Snippet
  graphics : Graphics
[read-only] A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Snippet
  groups : Groups
[read-only] A collection of groups.
Snippet
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Snippet.
Snippet
  images : Images
[read-only] A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
Snippet
  index : Number
[read-only] The index of the Snippet within its containing object.
Snippet
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Snippet
  label : String
A property that can be set to any string.
Snippet
  multiStateObjects : MultiStateObjects
[read-only] A collection of multi-state objects.
Snippet
  name : String
The name of the Snippet; this is an alias to the Snippet's label property.
Snippet
  ovals : Ovals
[read-only] A collection of ellipses.
Snippet
  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.
Snippet
  parent : PlaceGun
[read-only] The parent of the Snippet (a PlaceGun).
Snippet
  pdfs : PDFs
[read-only] A collection of PDF files.
Snippet
  picts : PICTs
[read-only] A collection of PICT graphics.
Snippet
  polygons : Polygons
[read-only] A collection of polygons.
Snippet
  properties : Object
A property that allows setting of several properties at the same time.
Snippet
  rectangles : Rectangles
[read-only] A collection of rectangles.
Snippet
  splineItems : SplineItems
[read-only] The spline items collection.
Snippet
  textFrames : TextFrames
[read-only] A collection of text frames.
Snippet
  wmfs : WMFs
[read-only] A collection of WMF graphics.
Snippet
Public Methods
 MethodDefined By
  
addEventListenerSnippet(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Snippet
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Snippet
 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
Resolves the object specifier, creating an array of object references.
Snippet
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Snippet
 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
  
remove():void
Deletes the Snippet.
Snippet
  
removeEventListenerSnippet(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Snippet
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
Snippet
 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
BEFORE_PLACEproperty
BEFORE_PLACE:String  [read-only]

Dispatched before a Snippet is placed. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_PLACE():String
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]

A collection of event listeners.


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

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
idproperty 
id:Number  [read-only]

The unique ID of the Snippet.


Implementation
    public function get id():Number
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
indexproperty 
index:Number  [read-only]

The index of the Snippet within its containing object.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
multiStateObjectsproperty 
multiStateObjects:MultiStateObjects  [read-only]

A collection of multi-state objects.


Implementation
    public function get multiStateObjects():MultiStateObjects
nameproperty 
name:String

The name of the Snippet; this is an alias to the Snippet's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
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:PlaceGun  [read-only]

The parent of the Snippet (a PlaceGun).


Implementation
    public function get parent():PlaceGun
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

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
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
addEventListenerSnippet()method
public function addEventListenerSnippet(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
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the Snippet.

removeEventListenerSnippet()method 
public function removeEventListenerSnippet(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 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String