dijit/_editor/selection.js

• Provides:

  • dijit._editor.selection

• dijit._editor.selection.getType

  • returns

    String

  • summary

    Get the selection type (like dojo.doc.select.type in IE).

  • type

    Function

• dijit._editor.selection.getSelectedText

  • returns

    String

  • summary

    Return the text (no html tags) included in the current selection or null if no text is selected

  • type

    Function

• dijit._editor.selection.getSelectedHtml

  • returns

    String

  • summary

    Return the html text of the current selection or null if unavailable

  • type

    Function

• dijit._editor.selection.getSelectedElement

  • summary

    Retrieves the selected element (if any), just in the case that
    a single element (object like and image or a table) is
    selected.

  • type

    Function

• dijit._editor.selection.getParentElement

  • summary

    Get the parent element of the current selection

  • type

    Function

• dijit._editor.selection.hasAncestorElement

  • parameters:
    • tagName: (typeof String)

      The tag name to determine if it has an ancestor of.

  • returns

    Boolean

  • summary

    Check whether current selection has a  parent element which is
    of type tagName (or one of the other specified tagName)

  • type

    Function

• dijit._editor.selection.getAncestorElement

  • parameters:
    • tagName: (typeof String)

      The tag name to determine if it has an ancestor of.

  • returns

    DOMNode

  • summary

    Return the parent element of the current selection which is of
    type tagName (or one of the other specified tagName)

  • type

    Function

• dijit._editor.selection.isTag

  • parameters:
    • node: (typeof DomNode)

      The node to inspect.

    • tags: (typeof String[])
  • returns

    String

  • summary

    Function to determine if a node is one of an array of tags.

  • tags: An array of tag name strings to check to see if the node matches.
  • type

    Function

• dijit._editor.selection.getParentOfType

  • parameters:
    • node: (typeof DomNode)

      The node to inspect.

    • tags: (typeof String[])
  • returns

    DOMNode

  • summary

    Function to locate a parent node that matches one of a set of tags

  • tags: An array of tag name strings to check to see if the node matches.
  • type

    Function

• dijit._editor.selection.collapse

  • parameters:
    • beginning: (typeof Boolean)

      Boolean to indicate whether to collapse the cursor to the beginning of the selection or end.

  • summary

    Function to collapse (clear), the current selection

  • type

    Function

• dijit._editor.selection.remove

  • returns

    Selection

  • summary

    Function to delete the currently selected content from the document.

  • type

    Function

• dijit._editor.selection.selectElementChildren

  • parameters:
    • element: (typeof DomNode)

      DOMNode The element you wish to select the children content of.

    • nochangefocus: (typeof Boolean)

      Boolean to indicate if the foxus should change or not.

  • summary

    clear previous selection and select the content of the node
    (excluding the node itself)

  • type

    Function

• dijit._editor.selection.selectElement

  • parameters:
    • element: (typeof DomNode)

      DOMNode The element to select.

    • nochangefocus: (typeof Boolean)

      Boolean indicating if the focus should be changed.  IE only.

  • summary

    clear previous selection and select element (including all its children)

  • type

    Function

• dijit._editor.selection.inSelection

  • parameters:
    • node
  • returns

    boolean

  • summary

    This function determines if 'node' is
    in the current selection.

  • tags: public
  • type

    Function

• dijit._editor.selection

  • type

    Object

• dijit._editor

  • type

    Object

• dijit

  • type

    Object