dojox/editor/plugins/FindReplace.js

• Provides:

  • dojox.editor.plugins.FindReplace

• Requires:

  • dojo.string in common
  • dijit.TooltipDialog in common
  • dijit.Toolbar in common
  • dijit.form.CheckBox in common
  • dijit.form.TextBox in common
  • dijit._editor._Plugin in common
  • dijit.form.Button in common
  • dojox.editor.plugins.ToolbarLineBreak in common
  • dojo.i18n in common

• dojox.editor.plugins._FindReplaceCloseBox

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Base class for widgets that contains a button labeled X
    to close the tool bar.

• dojox.editor.plugins._FindReplaceCloseBox.btnId

  • type

    String

• dojox.editor.plugins._FindReplaceCloseBox.widget

  • type

    Object

• dojox.editor.plugins._FindReplaceCloseBox.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins._FindReplaceCloseBox.templateString

  • type

    String

• dojox.editor.plugins._FindReplaceCloseBox.postMixInProperties

  • type

    Function

• dojox.editor.plugins._FindReplaceCloseBox.id

  • type

    Object

• dojox.editor.plugins._FindReplaceCloseBox.startup

  • type

    Function

• dojox.editor.plugins._FindReplaceCloseBox.onClick

  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Base class for widgets that contains a label (like "Font:")
    and a TextBox to pick a value.
    Used as Toolbar entry.

• dojox.editor.plugins._FindReplaceTextBox.textId

  • tags: public
  • type

    String

  • summary

    The id of the enhanced textbox

• dojox.editor.plugins._FindReplaceTextBox.label

  • tags: public
  • type

    String

  • summary

    The label of the enhanced textbox

• dojox.editor.plugins._FindReplaceTextBox.toolTip

  • type

    String

• dojox.editor.plugins._FindReplaceTextBox.widget

  • type

    Object

• dojox.editor.plugins._FindReplaceTextBox.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins._FindReplaceTextBox.templateString

  • type

    String

• dojox.editor.plugins._FindReplaceTextBox.postMixInProperties

  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox.id

  • type

    Object

• dojox.editor.plugins._FindReplaceTextBox.postCreate

  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox.disabled

  • type

    Object

• dojox.editor.plugins._FindReplaceTextBox._setValueAttr

  • parameters:
    • value: (typeof String)
  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox.value

• dojox.editor.plugins._FindReplaceTextBox.focus

  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)

      The boolean value to indicate if the textbox should be disabled or not

  • summary

    Over-ride for the textbox's 'disabled' attribute so that it can be
    disabled programmatically.

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox.onChange

  • parameters:
    • val: (typeof String)
  • summary

    Stub function for change events on the box.

  • tags: public
  • type

    Function

• dojox.editor.plugins._FindReplaceTextBox._onKeyPress

  • parameters:
    • evt: (typeof Event)

      object passed to this handler

  • summary

    Handle the arrow key events

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    Base class for widgets that contains a label (like "Match case: ")
    and a checkbox to indicate if it is checked or not.
    Used as Toolbar entry.

• dojox.editor.plugins._FindReplaceCheckBox.checkId

  • tags: public
  • type

    String

  • summary

    The id of the enhanced checkbox

• dojox.editor.plugins._FindReplaceCheckBox.label

  • tags: public
  • type

    String

  • summary

    The label of the enhanced checkbox

• dojox.editor.plugins._FindReplaceCheckBox.tooltip

  • tags: public
  • type

    String

  • summary

    The tooltip of the enhanced checkbox when the mouse is hovering it

• dojox.editor.plugins._FindReplaceCheckBox.widget

  • type

    Object

• dojox.editor.plugins._FindReplaceCheckBox.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins._FindReplaceCheckBox.templateString

  • type

    String

• dojox.editor.plugins._FindReplaceCheckBox.postMixInProperties

  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox.id

  • type

    Object

• dojox.editor.plugins._FindReplaceCheckBox.postCreate

  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox.disabled

  • type

    Object

• dojox.editor.plugins._FindReplaceCheckBox.checkBox.isFocusable

  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox._setValueAttr

  • parameters:
    • value: (typeof Boolean)
  • summary

    Passthrough for checkbox.

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox._getValueAttr

  • summary

    Passthrough for checkbox.

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox.focus

  • summary

    Handle the focus event when this widget gets focused

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceCheckBox._setDisabledAttr

  • parameters:
    • value: (typeof Boolean)

      The flag that indicates if the checkbox is disabled or not.

  • summary

    Over-ride for the button's 'disabled' attribute so that it can be
    disabled programmatically.

  • tags:
  • type

    Function

• dojox.editor.plugins._FindReplaceToolbar

  • type

    Function

  • chains:
    • dijit.Toolbar: (prototype)
    • dijit.Toolbar: (call)
  • summary

    A toolbar that derived from dijit.Toolbar, which
    eliminates some unnecessary event response such as LEFT_ARROW pressing
    and click bubbling.

• dojox.editor.plugins._FindReplaceToolbar.postCreate

  • type

    Function

• dojox.editor.plugins._FindReplaceToolbar.addChild

  • parameters:
    • widget: (typeof dijit._Widget)
    • insertIndex: (typeof int)
  • summary

    Add a child to our _Container and prevent the default
    arrow key navigation function. This function may bring in
    side effect

  • type

    Function

• dojox.editor.plugins._FindReplaceToolbar._onToolbarEvent

  • parameters:
    • evt: (typeof Event)

      The Event object
      tages:
      private

  • type

    Function

• dojox.editor.plugins.FindReplace

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    This plugin provides a Find/Replace cabability for the editor.
    Note that this plugin is NOT supported on Opera currently, as opera
    does not implement a window.find or equiv function.

• dojox.editor.plugins.FindReplace.buttonClass

  • alias - dijit.form.ToggleButton
  • tags:
  • type

    Define

  • summary

    the class of button the editor uses.

• dojox.editor.plugins.FindReplace.iconClassPrefix

  • tags: const
  • type

    String

  • summary

    The CSS class name for the button node is formed from <code>iconClassPrefix</code> and <code>command</code>

• dojox.editor.plugins.FindReplace.editor

  • tags:
  • type

    The

  • summary

    editor this plugin belongs to

• dojox.editor.plugins.FindReplace.button

  • tags:
  • type

    The

  • summary

    toggle button

• dojox.editor.plugins.FindReplace._frToolbar

  • tags:
  • type

    The

  • summary

    toolbar that contain all the entries and buttons

• dojox.editor.plugins.FindReplace._closeBox

  • tags:
  • type

    The

  • summary

    close button of the F/R toolbar

• dojox.editor.plugins.FindReplace._findField

  • tags:
  • type

    The

  • summary

    Find field of the F/R toolbar

• dojox.editor.plugins.FindReplace._replaceField

  • tags:
  • type

    The

  • summary

    Replace field of the F/R toolbar

• dojox.editor.plugins.FindReplace._findButton

  • tags:
  • type

    The

  • summary

    Find button of the F/R toolbar

• dojox.editor.plugins.FindReplace._replaceButton

  • tags:
  • type

    The

  • summary

    Replace button of the F/R toolbar

• dojox.editor.plugins.FindReplace._replaceAllButton

  • tags:
  • type

    The

  • summary

    ReplaceAll button of the F/R toolbar

• dojox.editor.plugins.FindReplace._caseSensitive

  • tags:
  • type

    The

  • summary

    case sensitive checkbox

• dojox.editor.plugins.FindReplace._backwards

  • tags:
  • type

    The

  • summary

    backwards checkbox

• dojox.editor.plugins.FindReplace._promDialog

  • tags:
  • type

    The

  • summary

    prompt message box that shows the user some messages
    such as the end of a search, the end of a replacement, etc.

• dojox.editor.plugins.FindReplace._promDialogTimeout

  • type

    Object

• dojox.editor.plugins.FindReplace._strings

  • tags:
  • type

    The

  • summary

    array that contains globalized strings

• dojox.editor.plugins.FindReplace._initButton

  • summary

    Over-ride for creation of the resize button.

  • type

    Function

• dojox.editor.plugins.FindReplace.setEditor

  • parameters:
    • editor
  • summary

    This is a callback handler that set a reference to the editor this plugin
    hosts in

  • type

    Function

• dojox.editor.plugins.FindReplace.toggle

  • summary

    Function to allow programmatic toggling of the find toolbar.

  • tags: public
  • type

    Function

• dojox.editor.plugins.FindReplace._toggleFindReplace

  • parameters:
    • show: (typeof Boolean)

      Indicate if the toolbar is shown or not

    • ignoreState: (typeof Boolean)

      Indicate if the status should be ignored or not
      blurEditor:
      Indicate if the focus should be removed from the editor or not

    • buttonDisabled: (typeof Boolean)
  • summary

    Function to toggle whether or not find/replace is displayed.

  • tags:
  • type

    Function

• dojox.editor.plugins.FindReplace._displayed

  • type

    bool

• dojox.editor.plugins.FindReplace._populateFindField

  • summary

    Populate the Find field with selected text when dialog initially displayed.
    Auto-select text in Find field after it is populated.
    If nothing selected, restore previous entry from the same session.

  • tags:
  • type

    Function

• dojox.editor.plugins.FindReplace.editor.window

• dojox.editor.plugins.FindReplace.setToolbar

  • parameters:
    • toolbar: (typeof dijit.Toolbar)

      The current toolbar of the editor

  • summary

    Over-ride so that find/replace toolbar is appended after the current toolbar.

  • tags: public
  • type

    Function

• dojox.editor.plugins.FindReplace._findButton.titleNode.title

• dojox.editor.plugins.FindReplace._replaceButton.titleNode.title

• dojox.editor.plugins.FindReplace._replaceAllButton.titleNode.title

• dojox.editor.plugins.FindReplace._checkButtons

  • summary

    Ensure that all the buttons are in a correct status
    when certain events are fired.

  • type

    Function

• dojox.editor.plugins.FindReplace._onFindKeyDown

  • parameters:
    • evt
  • type

    Function

• dojox.editor.plugins.FindReplace._onReplaceKeyDown

  • parameters:
    • evt
  • type

    Function

• dojox.editor.plugins.FindReplace._find

  • parameters:
    • showMessage: (typeof Boolean)

      Indicated whether the tooltip is shown or not when the search reaches the end

  • summary

    This function invokes a find on the editor document with the noted options for
    find.

  • tags: private.
  • return_summary

    Boolean indicating if the content was found or not.

  • type

    Function

• dojox.editor.plugins.FindReplace._replace

  • parameters:
    • showMessage: (typeof Boolean)

      Indicate if the prompt message is shown or not when the replacement
      reaches the end

  • summary

    This function invokes a replace on the editor document with the noted options for replace

  • tags:
  • return_summary

    Boolean indicating if the content was replaced or not.

  • type

    Function

• dojox.editor.plugins.FindReplace._replaceAll

  • parameters:
    • showMessage: (typeof Boolean)

      Indicate if the prompt message is shown or not when the action is done.

  • summary

    This function replaces all the matched content on the editor document
    with the noted options for replace

  • tags:
  • type

    Function

• dojox.editor.plugins.FindReplace._findText

  • parameters:
    • txt: (typeof String)

      The text to locate in the document.

    • caseSensitive: (typeof Boolean)

      Whether or ot to search case-sensitively.

    • backwards: (typeof Boolean)

      Whether or not to search backwards in the document.

  • summary

    This function invokes a find with specific options

  • tags: private.
  • return_summary

    Boolean indicating if the content was found or not.

  • type

    Function

• dojox.editor.plugins.FindReplace.editor.document

• dojox.editor.plugins.FindReplace._filterRegexp

  • parameters:
    • pattern: (typeof String)

      string A simple matching pattern to convert that follows basic rules:
      * Means match anything, so ca* means match anything starting with ca
      ? Means match single character.  So, b?b will match to bob and bab, and so on.
      \ is an escape character.  So for example, \* means do not treat * as a match, but literal character *.
      To use a \ as a character in the string, it must be escaped.  So in the pattern it should be
      represented by \\ to be treated as an ordinary \ character instead of an escape.

    • ignoreCase: (typeof Boolean)

      An optional flag to indicate if the pattern matching should be treated as case-sensitive or not when comparing
      By default, it is assumed case sensitive.

  • returns

    RegExp

  • summary

    Helper function to convert a simple pattern to a regular expression for matching.

  • description

    Returns a regular expression object that conforms to the defined conversion rules.
    For example:
    ca*   -> /^ca.*$/
    *ca*  -> /^.*ca.*$/
    *c\*a*  -> /^.*c\*a.*$/
    *c\*a?*  -> /^.*c\*a..*$/
    and so on.

  • tags:
  • type

    Function

• dojox.editor.plugins.FindReplace.updateState

  • summary

    Over-ride for button state control for disabled to work.

  • type

    Function

• dojox.editor.plugins.FindReplace.destroy

  • summary

    Cleanup of our custom toolbar.

  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object