Wikimedia\Dodo\Range Class Reference

A live range. More...

Inheritance diagram for Wikimedia\Dodo\Range:

Public Member Functions
	__construct (Document $doc)
	Constructor, used by Document::createRange()
Node	getCommonAncestorContainer ()
	setStart ( $node, int $offset)
	setEnd ( $node, int $offset)
	setStartBefore ( $node)
	setStartAfter ( $node)
	setEndBefore ( $node)
	setEndAfter ( $node)
	collapse (bool $toStart=false)
	selectNode ( $node)
	selectNodeContents ( $node)
int	compareBoundaryPoints (int $how, $sourceRange)
Range	cloneRange ()
	Return a new live range with the same start and end as this.
	detach ()
bool	isPointInRange ( $node, int $offset)
int	comparePoint ( $node, int $offset)
bool	intersectsNode ( $node)
string	toString ()
Public Member Functions inherited from Wikimedia\Dodo\AbstractRange
Node	getStartContainer ()
int	getStartOffset ()
Node	getEndContainer ()
int	getEndOffset ()
bool	getCollapsed ()
Public Member Functions inherited from Wikimedia::IDLeDOM::Range
void	deleteContents ()
DocumentFragment	extractContents ()
DocumentFragment	cloneContents ()
void	insertNode ( $node)
void	surroundContents ( $newParent)
DocumentFragment	createContextualFragment (string $fragment)

Additional Inherited Members
Protected Member Functions inherited from Wikimedia\Dodo\AbstractRange
	__construct (Node $startContainer, int $startOffset, Node $endContainer, int $endOffset)
	Create a new AbstractRange object.
Protected Attributes inherited from Wikimedia\Dodo\AbstractRange
BoundaryPoint	$_start
BoundaryPoint	$_end

Detailed Description

A live range.

See also

https://dom.spec.whatwg.org/#concept-live-range

Constructor & Destructor Documentation

__construct()

Wikimedia\Dodo\Range::__construct

(

Document

$doc

)

Constructor, used by Document::createRange()

See also

https://dom.spec.whatwg.org/#dom-document-createrange

Parameters

Document

$doc

The document associated with this Range

Member Function Documentation

cloneRange()

Range Wikimedia\Dodo\Range::cloneRange

(

)

Return a new live range with the same start and end as this.

See also

https://dom.spec.whatwg.org/#dom-range-clonerange

Returns

Range

Implements Wikimedia::IDLeDOM::Range.

collapse()

Wikimedia\Dodo\Range::collapse

(

bool

$toStart = false

)

Parameters

bool

$toStart

Implements Wikimedia::IDLeDOM::Range.

compareBoundaryPoints()

int Wikimedia\Dodo\Range::compareBoundaryPoints	(	int	$how,
			$sourceRange )

Parameters

int	$how
\Wikimedia\IDLeDOM\Range	$sourceRange

Returns

int

Implements Wikimedia::IDLeDOM::Range.

comparePoint()

int Wikimedia\Dodo\Range::comparePoint	(		$node,
		int	$offset )

Parameters

INode	$node
int	$offset

Returns

int

Implements Wikimedia::IDLeDOM::Range.

detach()

Wikimedia\Dodo\Range::detach

(

)

Implements Wikimedia::IDLeDOM::Range.

getCommonAncestorContainer()

Node Wikimedia\Dodo\Range::getCommonAncestorContainer

(

)

Returns

Node

Implements Wikimedia::IDLeDOM::Range.

intersectsNode()

bool Wikimedia\Dodo\Range::intersectsNode

(

$node

)

Parameters

INode

$node

Returns

bool

Implements Wikimedia::IDLeDOM::Range.

isPointInRange()

bool Wikimedia\Dodo\Range::isPointInRange	(		$node,
		int	$offset )

Parameters

INode	$node
int	$offset

Returns

bool

Implements Wikimedia::IDLeDOM::Range.

selectNode()

Wikimedia\Dodo\Range::selectNode

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

selectNodeContents()

Wikimedia\Dodo\Range::selectNodeContents

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

setEnd()

Wikimedia\Dodo\Range::setEnd	(		$node,
		int	$offset )

Parameters

INode	$node
int	$offset

Implements Wikimedia::IDLeDOM::Range.

setEndAfter()

Wikimedia\Dodo\Range::setEndAfter

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

setEndBefore()

Wikimedia\Dodo\Range::setEndBefore

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

setStart()

Wikimedia\Dodo\Range::setStart	(		$node,
		int	$offset )

Parameters

INode	$node
int	$offset

Implements Wikimedia::IDLeDOM::Range.

setStartAfter()

Wikimedia\Dodo\Range::setStartAfter

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

setStartBefore()

Wikimedia\Dodo\Range::setStartBefore

(

$node

)

Parameters

INode

$node

Implements Wikimedia::IDLeDOM::Range.

toString()

string Wikimedia\Dodo\Range::toString

(

)

Returns

string

Implements Wikimedia::IDLeDOM::Range.

---

The documentation for this class was generated from the following file:

• src/Range.php