Class

ContentPlacerObject

 Represents the content placer object. Base Class: Preference

QuickLinks

addEventListener, getElements, load, removeEventListener, toSource, toSpecifier

Hierarchy

Application

Preference

ContentPlacerObject

Event | EventListener | MutationEvent

Properties

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

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

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

Array of ContentPlacerObject getElements ()
Resolves the object specifier, creating an array of object references.

void load (pageItems: Array of PageItem[, linkPageItems: bool=false][, linkStories: bool=false][, mapStyles: bool=false][, showingOptions: bool=false])
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	bool	Whether to link pageItems in content placer (if true it will override link stories value) (Optional) (default: false)
linkStories	bool	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	bool	Whether to map styles in content placer (Optional) (default: false)
showingOptions	bool	Whether to display the link options dialog (Optional) (default: false)

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

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

string toSource ()
Generates a string which, if executed, will return the ContentPlacerObject.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.contentPlacer

Return

Array of ContentPlacerObject ContentPlacerObject.getElements ()

Jongware, 28-Apr-2012 v3.0.3i

Contents :: Index