ArticleChild

Member of a group that is part of an article.

Go to Property Listing | Method Listing

Methods:

addEventListener, getElements, move, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, PageItem

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the ArticleChild.

index

Number

readonly

The index of the ArticleChild within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

itemRef

PageItem

readonly

The underlying page item

parent

Group

readonly

The parent of the ArticleChild (a Group).

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)

ArticleChild getElements ()

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

ArticleChild move (to:LocationOptions, reference:ArticleChild)

Moves the ArticleChild to the specified location.

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location relative to the reference object or within the containing object.

reference

ArticleChild

The reference object. Note: Required when the to value specifies before or after. (Optional)

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)

String toSource ()

Generates a string which, if executed, will return the ArticleChild.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

ArticleChild.move()

ArticleChild.getElements()

ArticleChildren.anyItem()

ArticleChildren.everyItem()

ArticleChildren.nextItem()

ArticleChildren.previousItem()

ArticleChildren.itemByID()

ArticleChildren.item()

ArticleChildren.[]()

ArticleChildren.itemByRange()

ArticleChildren.firstItem()

ArticleChildren.lastItem()

ArticleChildren.middleItem()