Class Selection

Object
   |
   +--Selection

class Selection

Defined in util/selection.js

Field Detail

doc

Object doc

HTML document

win

Object win

Document's parent window

Selection

Selection(doc, win)

The Selection class deals with selection and selection ranges inside an HTML document

Parameters:
HTML - Document
HTML - parent window (optional)

clear

void clear()

Clean up the selection

collapse

void collapse(<Boolean> start)

Collapse the document selection

Parameters:
start - Collapse to start (true,null) or to end (false)

getBookmark

Object getBookmark()

Return a bookmark to the current selection range

getParentByTagNames

Object getParentByTagNames(<String> tags)

Traverses the document tree up searching for an element which tag is one of the listed tag names. Ex: "a,img,div,p"

Parameters:
tags - Comma-separated list of tag names

getRange

Object getRange()

Return the first range of the current selection, or create a new one

getSelectedElement

Object getSelectedElement()

Return the current selected element

getSelectedHTML

String getSelectedHTML()

Retrieve the HTML contents of the current selection

getSelection

Object getSelection()

Return the native selection object associated with the document

getType

String getType()

Get the type of the current selection. The possible values are "Control", "Text" or "None"

restore

void restore()

Restore the selection from the cache

save

void save()

Save the selection in an internal cache

selectElement

void selectElement(<Object> elm, collapse, start)

Set a new selection in the document, so that the passed element is between the start and end of the created selection range

Parameters:
elm - Element