ContentPlacerObject

Methods:

addEventListener, getElements, load, removeEventListener, toSource, toSpecifier

Objects:

Hierarchy:

Class: ContentPlacerObject

Property Listing

Property	Type	Access	Description
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
loaded	Boolean	readonly	Whether the Content Placer is currently loaded with content for placing.
parent	Application	readonly	The parent of the ContentPlacerObject (a Application).
properties	Object	read/write	A property that allows setting of several properties at the same time.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	File JavaScriptFunction	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

ContentPlacerObject getElements ()

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

undefined load (pageItems:Array of PageItem, [linkPageItems:Boolean=Boolean], [linkStories:Boolean=Boolean], [mapStyles:Boolean=Boolean], [showingOptions:Boolean=Boolean])

Load the Content Placer with one or more objects.

Parameter	Type	Description
pageItems	Array of PageItem	One or more page items to place or load
linkPageItems	Boolean	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	Boolean	Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item) (Optional) (default: false)
mapStyles	Boolean	Whether to map styles in content placer (Optional) (default: false)
showingOptions	Boolean	Whether to display the link options dialog (Optional) (default: false)

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	File JavaScriptFunction	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)