W3cubDocs

/Dojo

dojo/html._ContentSetter

Usage

var foo = new html._ContentSetter(params,node);

Parameter	Type	Description
params	Object
node	String \| DomNode

Properties

cleanContent

Defined by: dojo/html

Should the content be treated as a full html document, and the real content stripped of ,

wrapper before injection

content

Defined by: dojo/html

The content to be placed in the node. Can be an HTML string, a node reference, or a enumerable list of nodes

extractContent

Defined by: dojo/html

Should the content be treated as a full html document, and the real content stripped of <html> <body> wrapper before injection

id

Defined by: dojo/html

Usually only used internally, and auto-generated with each instance

node

Defined by: dojo/html

An node which will be the parent element that we set content into

parseContent

Defined by: dojo/html

Should the node by passed to the parser after the new content is set

parserScope

Defined by: dojo/html

Flag passed to parser. Root for attribute names to search for. If scopeName is dojo, will search for data-dojo-type (or dojoType). For backwards compatibility reasons defaults to dojo._scopeName (which is "dojo" except when multi-version support is used, when it will be something like dojo16, dojo20, etc.)

startup

Defined by: dojo/html

Start the child widgets after parsing them. Only obeyed if parseContent is true.

Methods

`empty()`

Defined by dojo/html

cleanly empty out existing content

`set(cont,params)`

Defined by dojo/html

front-end to the set-content sequence

Parameter	Type	Description
cont	String \| DomNode \| NodeList	Optional An html string, node or enumerable list of nodes for insertion into the dom If not provided, the object's content property will be used
params	Object	Optional

Returns: undefined

`setContent()`

Defined by dojo/html

sets the content on the node

`tearDown()`

Defined by dojo/html

manually reset the Setter instance if its being re-used for example for another set()

tearDown() is not called automatically. In normal use, the Setter instance properties are simply allowed to fall out of scope but the tearDown method can be called to explicitly reset this instance.

Events

`onBegin()`

Defined by: dojo/html

Called after instantiation, but before set(); It allows modification of any of the object properties - including the node and content provided - before the set operation actually takes place This default implementation checks for cleanContent and extractContent flags to optionally pre-process html string content

Returns: undefined

`onContentError(err)`

Defined by: dojo/html

Parameter	Type	Description
err	undefined

Returns: string

`onEnd()`

Defined by: dojo/html

Called after set(), when the new content has been pushed into the node It provides an opportunity for post-processing before handing back the node to the caller This default implementation checks a parseContent flag to optionally run the dojo parser over the new content

Returns: undefined

`onExecError(err)`

Defined by: dojo/html

Parameter	Type	Description
err	undefined

Returns: string

© 2005–2017 JS Foundation
Licensed under the AFL 2.1 and BSD 3-Clause licenses.
http://dojotoolkit.org/api/1.10/dojo/html._ContentSetter.html