dojox/html/styles.js

• Provides:

  • dojox.html.styles

• dojox.html.insertCssRule

  • parameters:
    • selector: (typeof String)

      A fully qualified class name, as it would appear in
      a CSS dojo.doc. Start classes with periods, target
      nodes with '#'. Large selectors can also be created
      like:
       "#myDiv.myClass span input"

    • declaration: (typeof String)

      A single string that would make up a style block, not
      including the curly braces. Include semi-colons between
      statements. Do not use JavaScript style declarations
      in camel case, use as you would in a CSS dojo.doc:
       "color:#ffoooo;font-size:12px;margin-left:5px;"

    • styleSheetName: (typeof String)

      optional )
      Name of the dynamic style sheet this rule should be
      inserted into. If is not found by that name, it is
      created. If no name is passed, the name "default" is
      used.

  • returns

    String

  • summary

    Creates a style and attaches it to a dynamically created stylesheet
    arguments:

  • type

    Function

• dojox.html.removeCssRule

  • parameters:
    • selector: (typeof String)
    • declaration: (typeof String)
    • styleSheetName: (typeof String)
  • returns

    Boolean

  • summary

    Removes a cssRule base on the selector and declaration passed
    The declaration is needed for cases of dupe selectors

  • description

    Only removes DYNAMICALLY created cssRules. If you
    created it with dojox.html.insertCssRule, it can be removed.

  • type

    Function

• dojox.html.getStyleSheet

  • parameters:
    • styleSheetName: (typeof String)
  • returns

    StyleSheet or false

  • summary

    Returns a style sheet based on the argument.
    Searches dynamic style sheets first. If no matches,
    searches document style sheets.
    
    argument: (optional)
    A title or an href to a style sheet. Title can be
    an attribute in a tag, or a dynamic style sheet
    reference. Href can be the name of the file.
    If no argument, the assumed created dynamic style
    sheet is used.

  • type

    Function

• dojox.html.getDynamicStyleSheet

  • parameters:
    • styleSheetName: (typeof String)
  • returns

    StyleSheet

  • summary

    Creates and returns a dynamically created style sheet
    used for dynamic styles
    
    argument:
    styleSheetName /* optional String
    The name given the style sheet so that multiple
    style sheets can be created and referenced. If
    no argument is given, the name "default" is used.

  • type

    Function

• dojox.html.enableStyleSheet

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

    Enables the style sheet with the name passed in the
    argument. Deafults to the default style sheet.

  • type

    Function

• dojox.html.disableStyleSheet

  • parameters:
    • styleSheetName
  • summary

    Disables the dynamic style sheet with the name passed in the
    argument. If no arg is passed, defaults to the default style sheet.

  • type

    Function

• dojox.html.activeStyleSheet

  • parameters:
    • title: (typeof ?String)
  • returns

    StyleSheet or Boolean - FIXME - doesn't make a lot of sense

  • summary

    Getter/Setter

  • description

    If passed a title, enables a that style sheet. All other
    toggle-able style sheets are disabled.
    If no argument is passed, returns currently enabled
    style sheet.

  • type

    Function

• dojox.html.getPreferredStyleSheet

  • type

    Function

• dojox.html.getToggledStyleSheets

  • returns

    Array

  • summary

    Searches HTML for style sheets that are "toggle-able" -
    can be enabled and disabled. These would include sheets
    with the title attribute, as well as the REL attribute.

  • return_summary

    An array of all toggle-able style sheets
    TODO: 	Sets of style sheets could be grouped according to
    an ID and used in sets, much like different
    groups of radio buttons. It would not however be
    according to W3C spec

  • type

    Function

• dojox.html.getStyleSheets

  • returns

    Object

  • summary

    Collects all the style sheets referenced in the HTML page,
    including any incuded via @import.

  • return_summary

    An hash map of all the style sheets.
    
    TODO: 	Does not recursively search for @imports, so it will
    only go one level deep.

  • type

    Function

• dojox.html.styles

  • type

    Object

• dojox.html

  • type

    Object

• dojox

  • type

    Object