dojox/widget/FeedPortlet.js

• Provides:

  • dojox.widget.FeedPortlet

• Requires:

  • dojox.widget.Portlet in common
  • dijit.Tooltip in common
  • dijit.form.TextBox in common
  • dijit.form.Button in common
  • dojox.data.GoogleFeedStore in common

• dojox.widget.FeedPortlet

  • type

    Function

  • chains:
    • dojox.widget.Portlet: (prototype)
    • dojox.widget.Portlet: (call)
  • summary

    A Portlet that loads a XML feed.

  • description

    The feed is displayed as
    an unordered list of links.	When a link is hovered over
    by the mouse, it displays a summary in a tooltip.

• dojox.widget.FeedPortlet.local

  • type

    Boolean

  • summary

    Specifies whether the feed is to be loaded from the same domain as the
    page, or a remote domain.	If local is true, then the feed must be an
    Atom feed.	If it is false, it can be an Atom or RSS feed.

• dojox.widget.FeedPortlet.maxResults

  • type

    Number

  • summary

    The number of results to display from the feed.

• dojox.widget.FeedPortlet.url

  • type

    String

  • summary

    The URL of the feed to load.	If this is different to the domain
    of the HTML page, local should be set to false.

• dojox.widget.FeedPortlet.openNew

  • type

    Boolean

  • summary

    If true, when a link is clicked it will open in a new window.
    If false, it will not.

• dojox.widget.FeedPortlet.showFeedTitle

  • type

    Object

• dojox.widget.FeedPortlet.postCreate

  • type

    Function

• dojox.widget.FeedPortlet.onFeedError

  • summary

    Called when a feed fails to load successfully.

  • type

    Function

• dojox.widget.FeedPortlet.containerNode.innerHTML

  • type

    String

• dojox.widget.FeedPortlet.addChild

  • parameters:
    • child
  • type

    Function

• dojox.widget.FeedPortlet._getTitle

  • parameters:
    • item
  • summary

    Gets the title of a feed item.

  • type

    Function

• dojox.widget.FeedPortlet._getLink

  • parameters:
    • item
  • summary

    Gets the href link of a feed item.

  • type

    Function

• dojox.widget.FeedPortlet._getContent

  • parameters:
    • item
  • summary

    Gets the summary of a feed item.

  • type

    Function

• dojox.widget.FeedPortlet._setUrlAttr

  • parameters:
    • url
  • summary

    Sets the URL to load.

  • type

    Function

• dojox.widget.FeedPortlet.startup

  • summary

    Loads the widget.

  • type

    Function

• dojox.widget.FeedPortlet.load

  • summary

    Loads the feed.

  • type

    Function

• dojox.widget.FeedPortlet.store

• dojox.widget.FeedPortlet.generateResults

  • parameters:
    • items
  • summary

    Generates a list of hyperlinks and displays a tooltip
    containing a summary when the mouse hovers over them.

  • type

    Function

• dojox.widget.FeedPortlet._resultList

  • type

    Object

• dojox.widget.ExpandableFeedPortlet

  • type

    Function

  • chains:
    • dojox.widget.FeedPortlet: (prototype)
    • dojox.widget.FeedPortlet: (call)
  • summary

    A FeedPortlet that uses an list of expandable links to display
    a feed.	An icon is placed to the left of each item
    which, when clicked, toggles the visible state
    of the item summary.

• dojox.widget.ExpandableFeedPortlet.onlyOpenOne

  • type

    Boolean

  • summary

    If true, only a single item can be expanded at any given time.

• dojox.widget.ExpandableFeedPortlet.generateResults

  • parameters:
    • items
  • summary

    Generates a list of items, and places an icon beside them that
    can be used to show or hide a summary of that item.

  • type

    Function

• dojox.widget.ExpandableFeedPortlet.store

• dojox.widget.ExpandableFeedPortlet._resultList

  • type

    Object

• dojox.widget.PortletFeedSettings

  • type

    Function

  • chains:
    • dojox.widget.PortletSettings: (prototype)
    • dojox.widget.PortletSettings: (call)
  • summary

    A Settings widget designed to be used with a dojox.widget.FeedPortlet

  • description

    It provides form items that the user can use to change the URL
    for a feed to load into the FeedPortlet.
    There are two forms that it can take.	<br>
    The first is to display a text field, with Load and Cancel buttons,
    which is prepopulated with the enclosing FeedPortlet's URL.
    If a <select> DOM node is used as the source node for this widget,
    it displays a list of predefined URLs that the user can select from
    to load into the enclosing FeedPortlet.

  • example

    <div dojoType="dojox.widget.PortletFeedSettings"></div>

  • example

    <select dojoType="dojox.widget.PortletFeedSettings">
    <option>http://www.dojotoolkit.org/aggregator/rss</option>
    <option>http://dojocampus.org/content/category/podcast/feed/</option>
    </select>

• dojox.widget.PortletFeedSettings.class

  • type

    String

• dojox.widget.PortletFeedSettings.urls

  • type

    Array

  • summary

    An array of JSON object specifying URLs to display in the
    PortletFeedSettings object. Each object contains a 'url' and 'label'
    attribute, e.g.
    [{url:'http:google.com', label:'Google'}, {url:'http://dojotoolkit.org', label: 'Dojo'}]

• dojox.widget.PortletFeedSettings.selectedIndex

  • type

    Number

  • summary

    The selected URL. Defaults to zero.

• dojox.widget.PortletFeedSettings.buildRendering

  • type

    Function

• dojox.widget.PortletFeedSettings.srcNodeRef

• dojox.widget.PortletFeedSettings.text

  • type

    Object

• dojox.widget.PortletFeedSettings._setContentAttr

  • type

    Function

• dojox.widget.PortletFeedSettings.postCreate

  • type

    Function

• dojox.widget.PortletFeedSettings.startup

  • summary

    Sets the portlet associated with this PortletSettings object.

  • type

    Function

• dojox.widget.PortletFeedSettings._getFeedPortletUrlAttr

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object