dojox/atom/widget/FeedViewer.js

• Provides:

  • dojox.atom.widget.FeedViewer

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._Container in common
  • dojox.atom.io.Connection in common

• dojox.atom.widget.FeedViewer

  • type

    Function

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

    An ATOM feed viewer that allows for viewing a feed, deleting entries, and editing entries.

  • description

    An ATOM feed viewer that allows for viewing a feed, deleting entries, and editing entries.
    
    
    The body of the feed viewer table so we can access it and populate it.  Will be assigned via template.
    
    
    The overal table container which contains the feed viewer table.  Will be assigned via template.
    
    
    The topic to broadcast when any entry is clicked so that a listener can pick up it and display it.
    
    
    The URL to which to connect to initially on creation.

• dojox.atom.widget.FeedViewer.feedViewerTableBody

  • type

    Object

• dojox.atom.widget.FeedViewer.feedViewerTable

  • type

    Object

• dojox.atom.widget.FeedViewer.entrySelectionTopic

  • type

    String

• dojox.atom.widget.FeedViewer.url

  • type

    String

• dojox.atom.widget.FeedViewer.xmethod

  • type

    bool

• dojox.atom.widget.FeedViewer.localSaveOnly

  • type

    bool

• dojox.atom.widget.FeedViewer.templateString

  • type

    Object

• dojox.atom.widget.FeedViewer._feed

  • type

    Object

• dojox.atom.widget.FeedViewer._currentSelection

  • type

    Object

• dojox.atom.widget.FeedViewer._includeFilters

  • type

    Array

• dojox.atom.widget.FeedViewer.alertsEnabled

  • type

    bool

• dojox.atom.widget.FeedViewer.postCreate

  • summary

    The postCreate function.

  • description

    The postCreate function.  Creates our AtomIO object for future interactions and subscribes to the
    event given in markup/creation.

  • type

    Function

• dojox.atom.widget.FeedViewer._subscriptions

  • type

    Array

• dojox.atom.widget.FeedViewer.atomIO

  • type

    Object

• dojox.atom.widget.FeedViewer.childWidgets

  • type

    Array

• dojox.atom.widget.FeedViewer.startup

  • summary

    The startup function.

  • description

    The startup function.  Parses the filters and sets the feed based on the given url.

  • type

    Function

• dojox.atom.widget.FeedViewer.containerNode

• dojox.atom.widget.FeedViewer.clear

  • summary

    Function clearing all current entries in the feed view.

  • description

    Function clearing all current entries in the feed view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer.setFeedFromUrl

  • parameters:
    • url: (typeof string)

      The URL to the feed to load.

  • summary

    Function setting the feed from a URL which to get the feed.

  • description

    Function setting the dojox.atom.io.model.Feed data into the view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer.setFeedFromUrl.url

  • type

    The

  • summary

    URL to the feed to load.

• dojox.atom.widget.FeedViewer.setFeed

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

    Function setting the dojox.atom.io.model.Feed data into the view.

  • description

    Function setting the dojox.atom.io.model.Feed data into the view.
    
    entry:
    The dojox.atom.io.model.Feed object to process

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._displayDateForEntry

  • parameters:
    • entry: (typeof object)

      The dojox.atom.io.model.Entry object to examine.

  • summary

    Internal function for determining the appropriate date to display.

  • description

    Internal function for determining of a particular entry is editable.

  • return_summary

    An appropriate date for the feed viewer display.

  • type

    Function

• dojox.atom.widget.FeedViewer.appendGrouping

  • parameters:
    • titleText: (typeof string)
  • summary

    Function for appending a new grouping of entries to the feed view.

  • description

    Function for appending a grouping of entries to the feed view.
    
    entry:
    The title of the new grouping to create on the view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer.appendEntry

  • parameters:
    • entry: (typeof object)

      The dojox.atom.io.model.Entry object to append

  • summary

    Function for appending an entry to the feed view.

  • description

    Function for appending an entry to the feed view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer.deleteEntry

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

    Function for deleting a row from the view

  • description

    Function for deleting a row from the view

  • type

    Function

• dojox.atom.widget.FeedViewer._removeEntry

  • parameters:
    • entry: (typeof FeedViewerEntry)
    • success: (typeof boolean)
  • summary

    callback for when an entry is deleted from a feed.

  • description

    callback for when an entry is deleted from a feed.

  • type

    Function

• dojox.atom.widget.FeedViewer._rowSelected

  • parameters:
    • evt: (typeof object)

      The click event that triggered a selection.

  • summary

    Internal function for handling the selection of feed entries.

  • description

    Internal function for handling the selection of feed entries.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._deselectCurrentSelection

  • summary

    Internal function for unselecting the current selection.

  • description

    Internal function for unselecting the current selection.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._isEditable

  • parameters:
    • entry: (typeof object)

      The dojox.atom.io.model.Entry object to examine

  • summary

    Internal function for determining of a particular entry is editable.

  • description

    Internal function for determining of a particular entry is editable.
    This is used for determining if the delete action should be displayed or not.

  • return_summary

    Boolean denoting if the entry seems editable or not..

  • type

    Function

• dojox.atom.widget.FeedViewer.onEntrySelected

  • parameters:
    • entry: (typeof object)

      The dojox.atom.io.model.Entry object selected.

  • summary

    Function intended for over-riding/replacement as an attachpoint to for other items to recieve
    selection notification.

  • description

    Function intended for over0-riding/replacement as an attachpoint to for other items to recieve
    selection notification.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._isRelativeURL

  • parameters:
    • url: (typeof string)

      The URL to inspect.

  • summary

    Method to determine if the URL is relative or absolute.

  • description

    Method to determine if the URL is relative or absolute.  Basic assumption is if it doesn't start
    with http:// or file://, it's relative to the current document.

  • return_summary

    boolean indicating whether it's a relative url or not.

  • type

    Function

• dojox.atom.widget.FeedViewer._calculateBaseURL

  • parameters:
    • fullURL: (typeof string)

      The full URL as a string.

    • currentPageRelative: (typeof boolean)

      Flag to denote of the base URL should be calculated as just the server base, or relative to the current page/location in the URL.

  • summary

    Internal function to calculate a baseline URL from the provided full URL.

  • description

    Internal function to calculate a baseline URL from the provided full URL.

  • return_summary

    String of the baseline URL

  • type

    Function

• dojox.atom.widget.FeedViewer._isFilterAccepted

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

    Internal function to do matching of category filters to widgets.

  • description

    Internal function to do matching of category filters to widgets.

  • return_summary

    boolean denoting if this entry matched one of the accept filters.

  • type

    Function

• dojox.atom.widget.FeedViewer.addCategoryIncludeFilter

  • parameters:
    • filter: (typeof object)

      The basic items to filter on and the values.
      Should be of format: {scheme: <some text or null>, term: <some text or null>, label: <some text or null>}

  • summary

    Function to add a filter for entry inclusion in the feed view.

  • description

    Function to add a filter for entry inclusion in the feed view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer.removeCategoryIncludeFilter

  • parameters:
    • filter: (typeof object)

      The basic items to identify the filter that is present.
      Should be of format: {scheme: <some text or null>, term: <some text or null>, label: <some text or null>}

  • summary

    Function to remove a filter for entry inclusion in the feed view.

  • description

    Function to remove a filter for entry inclusion in the feed view.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._handleEvent

  • parameters:
    • entrySelectionEvent: (typeof object)

      The topic message containing the entry that was selected for view.

  • summary

    Internal function for listening to a topic that will handle entry notification.

  • description

    Internal function for listening to a topic that will handle entry notification.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewer._addEntry

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

    callback function used when adding an entry to the feed.

  • description

    callback function used when adding an entry to the feed.  After the entry has been posted to the feed,
    we add it to our feed representation (to show it on the page) and publish an event to update any entry viewers.

  • type

    Function

• dojox.atom.widget.FeedViewer.destroy

  • summary

    Destroys this widget, including all descendants and subscriptions.

  • description

    Destroys this widget, including all descendants and subscriptions.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry

  • type

    Function

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

    Widget for handling the display of an entry and specific events associated with it.

  • description

    Widget for handling the display of an entry and specific events associated with it.

• dojox.atom.widget.FeedViewerEntry.templateString

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.entryNode

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.timeNode

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.deleteButton

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.entry

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.feed

  • type

    Object

• dojox.atom.widget.FeedViewerEntry.postCreate

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.deleteButton.innerHTML

• dojox.atom.widget.FeedViewerEntry.setTitle

  • parameters:
    • text: (typeof string)

      The title.

  • summary

    Function to set the title of the entry.

  • description

    Function to set the title of the entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.setTime

  • parameters:
    • timeText: (typeof string)

      The string form of the date.

  • summary

    Function to set the time of the entry.

  • description

    Function to set the time of the entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.enableDelete

  • summary

    Function to enable the delete action on this entry.

  • description

    Function to enable the delete action on this entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.deleteButton.style.display

  • type

    String

• dojox.atom.widget.FeedViewerEntry.disableDelete

  • summary

    Function to disable the delete action on this entry.

  • description

    Function to disable the delete action on this entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.deleteEntry

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

    Function to handle the delete event and delete the entry.

  • description

    Function to handle the delete event and delete the entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedViewerEntry.onClick

  • parameters:
    • e: (typeof object)

      The event generated by the click.

  • summary

    Attach point for when a row is clicked on.

  • description

    Attach point for when a row is clicked on.

  • type

    Function

• dojox.atom.widget.FeedViewerGrouping

  • type

    Function

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

    Grouping of feed entries.

  • description

    Grouping of feed entries.

• dojox.atom.widget.FeedViewerGrouping.templateString

  • type

    Object

• dojox.atom.widget.FeedViewerGrouping.groupingNode

  • type

    Object

• dojox.atom.widget.FeedViewerGrouping.titleNode

  • type

    Object

• dojox.atom.widget.FeedViewerGrouping.setText

  • parameters:
    • text: (typeof The)

      text to show.

  • summary

    Sets the text to be shown above this grouping.

  • description

    Sets the text to be shown above this grouping.

  • type

    Function

• dojox.atom.widget.AtomEntryCategoryFilter

  • type

    Function

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

    A filter to be applied to the list of entries.

  • description

    A filter to be applied to the list of entries.

• dojox.atom.widget.AtomEntryCategoryFilter.scheme

  • type

    String

• dojox.atom.widget.AtomEntryCategoryFilter.term

  • type

    String

• dojox.atom.widget.AtomEntryCategoryFilter.label

  • type

    String

• dojox.atom.widget.AtomEntryCategoryFilter.isFilter

  • type

    Object

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter

  • type

    Function

  • parameters:
    • scheme
    • term
    • label
  • summary

    The initializer function.

  • description

    The initializer function.

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • scheme
    • term
    • label
  • summary

    The initializer function.

  • description

    The initializer function.

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter.match

  • parameters:
    • entry
  • summary

    Function to determine if this category filter matches against a category on an atom entry

  • description

    Function to determine if this category filter matches against a category on an atom entry

  • return_summary

    boolean denoting if this category filter matched to this entry.

  • type

    Function

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter.scheme

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter.term

• dojox.atom.widget.FeedViewer.CategoryIncludeFilter.label

• dojox.atom.widget

  • type

    Object

• dojox.atom

  • type

    Object

• dojox

  • type

    Object