ArticleChild
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | 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 | bool | 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 | 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 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.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING 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) |
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 ArticleChild.
Used in:
ArticleChild ArticleChild.move (to: LocationOptions[, reference: ArticleChild])
ArticleChild ArticleChildren.nextItem (obj: ArticleChild)
ArticleChild ArticleChildren.previousItem (obj: ArticleChild)
Return
Array of ArticleChild ArticleChild.getElements ()
ArticleChild ArticleChild.move (to: LocationOptions[, reference: ArticleChild])
ArticleChild ArticleChildren.[] (index: number)
ArticleChild ArticleChildren.anyItem ()
Array of ArticleChild ArticleChildren.everyItem ()
ArticleChild ArticleChildren.firstItem ()
ArticleChild ArticleChildren.item (index: varies)
ArticleChild ArticleChildren.itemByID (id: number)
Array of ArticleChild ArticleChildren.itemByRange (from: varies, to: varies)
ArticleChild ArticleChildren.lastItem ()
ArticleChild ArticleChildren.middleItem ()
ArticleChild ArticleChildren.nextItem (obj: ArticleChild)
ArticleChild ArticleChildren.previousItem (obj: ArticleChild)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |