dojox/data/HtmlStore.js

• Provides:

  • dojox.data.HtmlStore

• Requires:

  • dojo.data.util.simpleFetch in common
  • dojo.data.util.filter in common
  • dojox.xml.parser in common

• dojox.data.HtmlStore

  • type

    Function

  • chains:
    • dojo.data.util.simpleFetch: (prototype)
  • parameters:
    • args: (typeof Object)

      An anonymous object to initialize properties.  It expects the following values:

  • summary

    Initializer for the HTML table store.

  • description

    The HtmlStore can be created in one of two ways: a) by parsing an existing
    table or list DOM node on the current page or b) by referencing an external url and giving
    the id of the table or list in that page.  The remote url will be parsed as an html page.
    
    The HTML table or list should be of the following form:
    
    	<table id="myTable">
    		<thead>
    			<tr>
    				<th>Attribute1</th>
    				<th>Attribute2</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr>
    				<td>Value1.1</td>
    				<td>Value1.2</td>
    			</tr>
    			<tr>
    				<td>Value2.1</td>
    				<td>Value2.2</td>
    			</tr>
    		</tbody>
    	</table>
    
    -or-
    
    	<ul id="myUnorderedList">
    		<li>Value.1</li>
    		<li>Value.2</li>
    	</ul>
    
    -or-
    
    	<ol id="myOrderedList">
    		<li>Value.1</li>
    		<li>Value.2</li>
    	</ol>

• dojox.data.HtmlStore.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args: (typeof Object)

      An anonymous object to initialize properties.  It expects the following values:

  • summary

    Initializer for the HTML table store.

  • description

    The HtmlStore can be created in one of two ways: a) by parsing an existing
    table or list DOM node on the current page or b) by referencing an external url and giving
    the id of the table or list in that page.  The remote url will be parsed as an html page.
    
    The HTML table or list should be of the following form:
    
    	<table id="myTable">
    		<thead>
    			<tr>
    				<th>Attribute1</th>
    				<th>Attribute2</th>
    			</tr>
    		</thead>
    		<tbody>
    			<tr>
    				<td>Value1.1</td>
    				<td>Value1.2</td>
    			</tr>
    			<tr>
    				<td>Value2.1</td>
    				<td>Value2.2</td>
    			</tr>
    		</tbody>
    	</table>
    
    -or-
    
    	<ul id="myUnorderedList">
    		<li>Value.1</li>
    		<li>Value.2</li>
    	</ul>
    
    -or-
    
    	<ol id="myOrderedList">
    		<li>Value.1</li>
    		<li>Value.2</li>
    	</ol>

• dojox.data.HtmlStore.url

  • type

    The

  • summary

    string The URL from which to load an HTML document for data loading

  • tags: public

• dojox.data.HtmlStore.dataId

  • type

    The

  • summary

    string The id in the document for an element from which to get the data.

  • tags: public

• dojox.data.HtmlStore.trimWhitespace

  • type

    Trim

  • summary

    off any surrounding whitespace from the headers (attribute
    names) and text content of the items in question.  Default is false for
    backwards compatibility.

• dojox.data.HtmlStore.urlPreventCache

  • tags: public
  • type

    boolean

  • summary

    Flag to denote if peventCache should be used on xhrGet calls.

• dojox.data.HtmlStore.fetchOnCreate

  • tags: public
  • type

    boolean

  • summary

    Flag to denote if it should try to load from a data id (nested in the page)
    The moment the store is created, instead of waiting for first
    fetch call.

• dojox.data.HtmlStore._indexItems

  • summary

    Function to index items found under the id.

  • tags:
  • type

    Function

• dojox.data.HtmlStore._rootNode

  • type

    Object

• dojox.data.HtmlStore._getHeadings

  • summary

    Function to load the attribute names from the table header so that the
    attributes (cells in a row), can have a reasonable name.
    For list items, returns single implicit heading, ["name"]

  • type

    Function

• dojox.data.HtmlStore._headings

  • type

    Array

• dojox.data.HtmlStore._getAllItems

  • returns

    array

  • summary

    Function to return all rows in the table as an array of items.

  • type

    Function

• dojox.data.HtmlStore._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.HtmlStore._assertIsAttribute

  • parameters:
    • attribute: (typeof String)

      The attribute to test for being contained by the store.

  • returns

    int

  • summary

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

  • return_summary

    Returns the index (column) that the attribute resides in the row.

  • type

    Function

• dojox.data.HtmlStore.getValue

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

    Object||int|Boolean

  • summary

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

  • type

    Function

• dojox.data.HtmlStore.getValues

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

    Array

  • summary

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

  • type

    Function

• dojox.data.HtmlStore.getAttributes

  • parameters:
    • item: (typeof item)
  • returns

    Array

  • summary

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

  • type

    Function

• dojox.data.HtmlStore.hasAttribute

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

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

  • type

    Function

• dojox.data.HtmlStore.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.HtmlStore._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.HtmlStore.isItem

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

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

  • type

    Function

• dojox.data.HtmlStore.isItemLoaded

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

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

  • type

    Function

• dojox.data.HtmlStore.loadItem

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

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

  • type

    Function

• dojox.data.HtmlStore._fetchItems

  • parameters:
    • request: (typeof A)

      request object

    • fetchHandler: (typeof A)

      function to call for fetched items

    • errorHandler: (typeof A)

      function to call on error

  • summary

    Fetch items (XML elements) that match to a query

  • description

    If '_fetchUrl' is specified, it is used to load an XML document
    with a query string.
    Otherwise and if 'url' is specified, the XML document is
    loaded and list XML elements that match to a query (set of element
    names and their text attribute values that the items to contain).
    A wildcard, "*" can be used to query values to match all
    occurrences.
    If '_rootItem' is specified, it is used to fetch items.

  • type

    Function

• dojox.data.HtmlStore._finishFetchItems

  • parameters:
    • request
    • fetchHandler
    • errorHandler
  • summary

    Internal function for processing the passed in request and locating the requested items.

  • type

    Function

• dojox.data.HtmlStore.getFeatures

  • summary

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

  • type

    Function

• dojox.data.HtmlStore.close

  • parameters:
    • request: (typeof dojo.data.api.Request)

      || keywordArgs || null

  • summary

    See dojo.data.api.Read.close()
    nothing to do here!

  • type

    Function

• dojox.data.HtmlStore.getLabel

  • parameters:
    • item: (typeof item)
  • summary

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

  • type

    Function

• dojox.data.HtmlStore.getLabelAttributes

  • parameters:
    • item: (typeof item)
  • summary

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

  • type

    Function

• dojox.data.HtmlStore.getIdentity

  • parameters:
    • item: (typeof item)
  • summary

    See dojo.data.api.Identity.getIdentity()

  • type

    Function

• dojox.data.HtmlStore.getIdentityAttributes

  • parameters:
    • item: (typeof item)
  • summary

    See dojo.data.api.Identity.getIdentityAttributes()
    Identity isn't taken from a public attribute.

  • type

    Function

• dojox.data.HtmlStore.fetchItemByIdentity

  • parameters:
    • keywordArgs
  • summary

    See dojo.data.api.Identity.fetchItemByIdentity()

  • type

    Function

• dojox.data

  • type

    Object

• dojox

  • type

    Object