dojox/data/CssRuleStore.js

• Provides:

  • dojox.data.CssRuleStore

• Requires:

  • dojo.data.util.filter in common
  • dojox.data.css in common

• dojox.data.CssRuleStore

  • type

    Function

  • parameters:
    • keywordParameters: (typeof Object)
  • summary

    Basic store to display CSS information.

  • description

    The CssRuleStore allows users to get information about active CSS rules in the page running the CssRuleStore.
    It can also filter out rules from specific stylesheets.  The attributes it exposes on rules are as follows:
    selector:				The selector text.
    classes:				An array of classes present in this selector.
    rule:					The actual DOM Rule object.
    style:					The actual DOM CSSStyleDeclaration object.
    cssText:				The cssText string provided on the rule object.
    styleSheet:				The originating DOM Stylesheet object.
    parentStyleSheet: 		The parent stylesheet to the sheet this rule originates from.
    parentStyleSheetHref: 	The href of the parent stylesheet.
    AND every style attribute denoted as style.*, such as style.textAlign or style.backgroundColor

• dojox.data.CssRuleStore._storeRef

  • type

    String

• dojox.data.CssRuleStore._labelAttribute

  • type

    String

• dojox.data.CssRuleStore._cache

  • type

    Object

• dojox.data.CssRuleStore._browserMap

  • type

    Object

• dojox.data.CssRuleStore._cName

  • type

    String

• dojox.data.CssRuleStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • keywordParameters: (typeof Object)

• dojox.data.CssRuleStore.setContext

  • parameters:
    • context: (typeof Array)

      - Array of CSS string paths to execute queries within

  • type

    Function

• dojox.data.CssRuleStore.context

  • type

    Object

• dojox.data.CssRuleStore.setContext.context

  • type

    Array

  • summary

    - Array of CSS string paths to execute queries within

• dojox.data.CssRuleStore.getFeatures

  • summary

    See dojo.data.api.Read.getFeatures()

  • type

    Function

• dojox.data.CssRuleStore.isItem

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.isItem()

  • type

    Function

• dojox.data.CssRuleStore.hasAttribute

  • parameters:
    • item
    • attribute
  • summary

    See dojo.data.api.Read.hasAttribute()

  • type

    Function

• dojox.data.CssRuleStore.getAttributes

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getAttributes()

  • type

    Function

• dojox.data.CssRuleStore.getValue

  • parameters:
    • item
    • attribute
    • defaultValue
  • summary

    See dojo.data.api.Read.getValue()

  • type

    Function

• dojox.data.CssRuleStore.getValues

  • parameters:
    • item
    • attribute
  • summary

    See dojo.data.api.Read.getValues()

  • type

    Function

• dojox.data.CssRuleStore.getLabel

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getLabel()

  • type

    Function

• dojox.data.CssRuleStore.getLabelAttributes

  • parameters:
    • item
  • summary

    See dojo.data.api.Read.getLabelAttributes()

  • type

    Function

• dojox.data.CssRuleStore.containsValue

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • value: (typeof anything)
  • returns

    boolean.

  • summary

    See dojo.data.api.Read.containsValue()

  • type

    Function

• dojox.data.CssRuleStore.isItemLoaded

  • parameters:
    • something: (typeof anything)
  • returns

    boolean

  • summary

    See dojo.data.api.Read.isItemLoaded()

  • type

    Function

• dojox.data.CssRuleStore.loadItem

  • parameters:
    • keywordArgs: (typeof object)
  • summary

    See dojo.data.api.Read.loadItem()

  • type

    Function

• dojox.data.CssRuleStore.fetch

  • parameters:
    • request
  • summary

    See dojo.data.api.Read.fetch()

  • type

    Function

• dojox.data.CssRuleStore._pending

  • type

    Array

• dojox.data.CssRuleStore._fetch

  • parameters:
    • request
  • summary

    Populates the _allItems object with unique class names

  • type

    Function

• dojox.data.CssRuleStore._allItems

  • type

    Object

• dojox.data.CssRuleStore._handleRule

  • parameters:
    • rule
    • styleSheet
    • href
  • summary

    Handles the creation of an item based on the passed rule.  In this store, this implies
    parsing out all available class names.

  • type

    Function

• dojox.data.CssRuleStore._handleReturn

  • summary

    Handles the return from a fetching action.  Delegates requests to act on the resulting
    item set to eitehr the _handleFetchReturn or _handleFetchByIdentityReturn depending on
    where the request originated.

  • type

    Function

• dojox.data.CssRuleStore._handleFetchReturn

  • parameters:
    • request: (typeof Request)
  • summary

    Handles a fetchByIdentity request by finding the correct items.

  • type

    Function

• dojox.data.CssRuleStore.close

  • summary

    See dojo.data.api.Read.close()
    Clears out the cache and allItems objects, meaning all future fetches will requery
    the stylesheets.

  • type

    Function

• dojox.data.CssRuleStore._assertIsItem

  • parameters:
    • item: (typeof item)

      The item to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed an item in the store.

  • type

    Function

• dojox.data.CssRuleStore._assertIsAttribute

  • parameters:
    • attribute: (typeof attribute-name-string)

      The attribute to test for being contained by the store.

  • summary

    This function tests whether the item passed in is indeed a valid 'attribute' like type for the store.

  • type

    Function

• dojox.data.CssRuleStore._containsValue

  • parameters:
    • item: (typeof item)

      The data item to examine for attribute values.

    • attribute: (typeof attribute-name-string)

      The attribute to inspect.

    • value: (typeof anything)

      The value to match.

    • regexp: (typeof RegExp)

      Optional regular expression generated off value if value was of string type to handle wildcarding.
      If present and attribute values are string, then it can be used for comparison instead of 'value'

  • returns

    Boolean

  • summary

    Internal function for looking at the values contained by the item.

  • description

    Internal function for looking at the values contained by the item.  This
    function allows for denoting if the comparison should be case sensitive for
    strings or not (for handling filtering cases where string case should not matter)

  • type

    Function

• dojox.data.CssRuleStore._waiting

  • type

    Array

• dojox.data.CssRuleStore.gatherHandle

  • type

    Object

• dojox.data

  • type

    Object

• dojox

  • type

    Object