dojox/highlight/_base.js

• Provides:

  • dojox.highlight._base

• • type

    Function

• dojox.highlight

  • summary

    Syntax highlighting with language auto-detection package

  • description

    Syntax highlighting with language auto-detection package.
    Released under CLA by the Dojo Toolkit, original BSD release
    available from: http://softwaremaniacs.org/soft/highlight/

  • alias - dojox.highlight
  • type

    Object

• dojox.highlight.constants

  • type

    Object

• dojox.highlight.constants.IDENT_RE

  • type

    String

• dojox.highlight.constants.UNDERSCORE_IDENT_RE

  • type

    String

• dojox.highlight.constants.NUMBER_RE

  • type

    String

• dojox.highlight.constants.C_NUMBER_RE

  • alias - C_NUMBER_RE

• dojox.highlight.constants.APOS_STRING_MODE

  • type

    Object

• dojox.highlight.constants.APOS_STRING_MODE.className

  • type

    String

• dojox.highlight.constants.APOS_STRING_MODE.begin

  • type

    String

• dojox.highlight.constants.APOS_STRING_MODE.end

  • type

    String

• dojox.highlight.constants.APOS_STRING_MODE.illegal

  • type

    String

• dojox.highlight.constants.APOS_STRING_MODE.contains

  • type

    Array

• dojox.highlight.constants.APOS_STRING_MODE.relevance

  • type

    Number

• dojox.highlight.constants.QUOTE_STRING_MODE

  • type

    Object

• dojox.highlight.constants.QUOTE_STRING_MODE.className

  • type

    String

• dojox.highlight.constants.QUOTE_STRING_MODE.begin

  • type

    String

• dojox.highlight.constants.QUOTE_STRING_MODE.end

  • type

    String

• dojox.highlight.constants.QUOTE_STRING_MODE.illegal

  • type

    String

• dojox.highlight.constants.QUOTE_STRING_MODE.contains

  • type

    Array

• dojox.highlight.constants.QUOTE_STRING_MODE.relevance

  • type

    Number

• dojox.highlight.constants.BACKSLASH_ESCAPE

  • type

    Object

• dojox.highlight.constants.BACKSLASH_ESCAPE.className

  • type

    String

• dojox.highlight.constants.BACKSLASH_ESCAPE.begin

  • type

    String

• dojox.highlight.constants.BACKSLASH_ESCAPE.end

  • type

    String

• dojox.highlight.constants.BACKSLASH_ESCAPE.relevance

  • type

    Number

• dojox.highlight.constants.C_LINE_COMMENT_MODE

  • type

    Object

• dojox.highlight.constants.C_LINE_COMMENT_MODE.className

  • type

    String

• dojox.highlight.constants.C_LINE_COMMENT_MODE.begin

  • type

    String

• dojox.highlight.constants.C_LINE_COMMENT_MODE.end

  • type

    String

• dojox.highlight.constants.C_LINE_COMMENT_MODE.relevance

  • type

    Number

• dojox.highlight.constants.C_BLOCK_COMMENT_MODE

  • type

    Object

• dojox.highlight.constants.C_BLOCK_COMMENT_MODE.className

  • type

    String

• dojox.highlight.constants.C_BLOCK_COMMENT_MODE.begin

  • type

    String

• dojox.highlight.constants.C_BLOCK_COMMENT_MODE.end

  • type

    String

• dojox.highlight.constants.HASH_COMMENT_MODE

  • type

    Object

• dojox.highlight.constants.HASH_COMMENT_MODE.className

  • type

    String

• dojox.highlight.constants.HASH_COMMENT_MODE.begin

  • type

    String

• dojox.highlight.constants.HASH_COMMENT_MODE.end

  • type

    String

• dojox.highlight.constants.C_NUMBER_MODE

  • type

    Object

• dojox.highlight.constants.C_NUMBER_MODE.className

  • type

    String

• dojox.highlight.constants.C_NUMBER_MODE.begin

  • alias - C_NUMBER_RE

• dojox.highlight.constants.C_NUMBER_MODE.end

  • type

    String

• dojox.highlight.constants.C_NUMBER_MODE.relevance

  • type

    Number

• dojox.highlight.processString

  • parameters:
    • str: (typeof String)
    • lang: (typeof String)
  • summary

    highlight a string of text

  • return_summary

    Object containing:
    result - string of html with spans to apply formatting
    partialResult - if the formating failed: string of html
    up to the point of the failure, otherwise: undefined
    langName - the language used to do the formatting

  • type

    Function

• dojox.highlight.init

  • parameters:
    • node: (typeof String|DomNode)
  • returns

    stop iterations|continue iterations

  • summary

    Highlight a passed node

  • description

    Syntax highlight a passed DomNode or String ID of a DomNode

  • example

    	dojox.highlight.init("someId");

  • type

    Function

• dojox.highlight.Code

  • parameters:
    • props: (typeof Object)

      Unused. Pass 'null' or {}. Positional usage to allow <code>dojo.parser</code> to instantiate
      this class as other Widgets would be.

    • node: (typeof String|DomNode)

      A String ID or DomNode reference to use as the root node of this instance.

    • p
    • n
  • summary

    A Class object to allow for dojoType usage with the highlight engine. This is
    NOT a Widget in the conventional sense, and does not have any member functions for
    the instance. This is provided as a convenience. You likely should be calling
    <code>dojox.highlight.init</code> directly.

  • example

    	<pre><code dojoType="dojox.highlight.Code">for(var i in obj){ ... }</code></pre>

  • example

    	var inst = new dojox.highlight.Code({}, "someId");

  • type

    Function

• dojox.highlight.Code.node

  • type

    String|DomNode

  • summary

    A String ID or DomNode reference to use as the root node of this instance.

• dojox.highlight._base

  • type

    Object

• dojox

  • type

    Object