dojox/atom/widget/FeedEntryViewer.js

• Provides:

  • dojox.atom.widget.FeedEntryViewer

• Requires:

  • dojo.fx in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._Container in common
  • dijit.layout.ContentPane in common
  • dojox.atom.io.Connection in common

• dojox.atom.widget.FeedEntryViewer

  • 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 entry editor for publishing updated ATOM entries, or viewing non-editable entries.

  • description

    An ATOM feed entry editor for publishing updated ATOM entries, or viewing non-editable entries.
    
    
    The topic to listen on for entries to edit.

• dojox.atom.widget.FeedEntryViewer.entrySelectionTopic

  • type

    String

• dojox.atom.widget.FeedEntryViewer._validEntryFields

  • type

    Object

• dojox.atom.widget.FeedEntryViewer.displayEntrySections

  • type

    String

• dojox.atom.widget.FeedEntryViewer._displayEntrySections

  • type

    Array

• dojox.atom.widget.FeedEntryViewer.enableMenu

  • type

    bool

• dojox.atom.widget.FeedEntryViewer.enableMenuFade

  • type

    bool

• dojox.atom.widget.FeedEntryViewer._optionButtonDisplayed

  • type

    Object

• dojox.atom.widget.FeedEntryViewer.templateString

  • type

    Object

• dojox.atom.widget.FeedEntryViewer._entry

  • type

    Object

• dojox.atom.widget.FeedEntryViewer._feed

  • type

    Object

• dojox.atom.widget.FeedEntryViewer._editMode

  • type

    bool

• dojox.atom.widget.FeedEntryViewer.postCreate

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._subscriptions

  • type

    Array

• dojox.atom.widget.FeedEntryViewer.displayOptions.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelTitle.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelAuthors.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelContributors.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelId.innerHTML

• dojox.atom.widget.FeedEntryViewer.close.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelUpdated.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelSummary.innerHTML

• dojox.atom.widget.FeedEntryViewer.feedEntryCheckBoxLabelContent.innerHTML

• dojox.atom.widget.FeedEntryViewer.startup

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.clear

  • summary

    Function to clear the state of the widget.

  • description

    Function to clear the state of the widget.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.clearNodes

  • summary

    Function to clear all the display nodes for the ATOM entry from the viewer.

  • description

    Function to clear all the display nodes for the ATOM entry from the viewer.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setEntry

  • parameters:
    • entry: (typeof object)

      Instance of dojox.atom.io.model.Entry to display for reading/editing.

    • feed: (typeof object)
    • leaveMenuState: (typeof boolean)
  • summary

    Function to set the current entry that is being edited.

  • description

    Function to set the current entry that is being edited.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setTitleHeader

  • parameters:
    • titleHeaderNode: (typeof DOM)

      node

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the title header node in the template to some value.

  • description

    Function to set the contents of the title header node in the template to some value.
    This exists specifically so users can over-ride how the title data is filled out from an entry.
    
    titleAchorNode:
    The DOM node to attach the title data to.
    editMode:
    Boolean to indicate if the display should be in edit mode or not.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setTitle

  • parameters:
    • titleAnchorNode
    • editMode: (typeof Boolean)

      to indicate if the display should be in edit mode or not.

    • entry: (typeof The)

      Feed Entry to work with.

  • summary

    Function to set the contents of the title node in the template to some value from the entry.

  • description

    Function to set the contents of the title node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.
    
    titleAchorNode:
    The DOM node to attach the title data to.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setAuthorsHeader

  • parameters:
    • authorHeaderNode: (typeof DOM)

      The DOM node to attach the author section header data to.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the title format for the authors section of the author row in the template to some value from the entry.

  • description

    Function to set the title format for the authors section of the author row in the template to some value from the entry.
    This exists specifically so users can over-ride how the author data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setAuthors

  • parameters:
    • authorsAnchorNode: (typeof DOM)

      node

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the author node in the template to some value from the entry.

  • description

    Function to set the contents of the author node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.
    
    authorsAchorNode:
    The DOM node to attach the author data to.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setContributorsHeader

  • parameters:
    • contributorsHeaderNode: (typeof DOM)

      The DOM node to attach the contributor title to.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the contributor header node in the template to some value from the entry.

  • description

    Function to set the contents of the contributor header node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setContributors

  • parameters:
    • contributorsAnchorNode: (typeof DOM)

      The DOM node to attach the contributor data to.

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the contributor node in the template to some value from the entry.

  • description

    Function to set the contents of the contributor node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setIdHeader

  • parameters:
    • idHeaderNode: (typeof DOM)

      node

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the ID  node in the template to some value from the entry.

  • description

    Function to set the contents of the ID node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.
    
    idAnchorNode:
    The DOM node to attach the ID data to.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setId

  • parameters:
    • idAnchorNode: (typeof DOM)

      The DOM node to attach the ID data to.

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the ID  node in the template to some value from the entry.

  • description

    Function to set the contents of the ID node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setUpdatedHeader

  • parameters:
    • updatedHeaderNode: (typeof DOM)

      The DOM node to attach the updated header data to.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the updated header node in the template to some value from the entry.

  • description

    Function to set the contents of the updated header node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setUpdated

  • parameters:
    • updatedAnchorNode: (typeof DOM)

      The DOM node to attach the udpated data to.

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the updated  node in the template to some value from the entry.

  • description

    Function to set the contents of the updated node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setSummaryHeader

  • parameters:
    • summaryHeaderNode: (typeof DOM)

      The DOM node to attach the summary title to.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the summary  node in the template to some value from the entry.

  • description

    Function to set the contents of the summary node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setSummary

  • parameters:
    • summaryAnchorNode: (typeof DOM)

      The DOM node to attach the summary data to.

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the summary  node in the template to some value from the entry.

  • description

    Function to set the contents of the summary node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setContentHeader

  • parameters:
    • contentHeaderNode: (typeof DOM)

      The DOM node to attach the content data to.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the content node in the template to some value from the entry.

  • description

    Function to set the contents of the content node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setContent

  • parameters:
    • contentAnchorNode: (typeof DOM)

      The DOM node to attach the content data to.

    • editMode: (typeof boolean)

      Boolean to indicate if the display should be in edit mode or not.

    • entry: (typeof object)

      The Feed Entry to work with.

  • summary

    Function to set the contents of the content node in the template to some value from the entry.

  • description

    Function to set the contents of the content node in the template to some value from the entry.
    This exists specifically so users can over-ride how the title data is filled out from an entry.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._displaySections

  • summary

    Internal function for determining which sections of the view to actually display.

  • description

    Internal function for determining which sections of the view to actually display.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.setDisplaySections

  • parameters:
    • sectionsArray: (typeof array)

      Array of string names that indicate which sections to display.

  • summary

    Function for setting which sections of the entry should be displayed.

  • description

    Function for setting which sections of the entry should be displayed.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._setDisplaySectionsCheckboxes

  • summary

    Internal function for setting which checkboxes on the display are selected.

  • description

    Internal function for setting which checkboxes on the display are selected.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._readDisplaySections

  • summary

    Internal function for reading what is currently checked for display and generating the display list from it.

  • description

    Internal function for reading what is currently checked for display and generating the display list from it.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._toggleCheckbox

  • parameters:
    • checkBox: (typeof object)

      The checkbox object to toggle the selection on.

  • 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

    Nothing

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._toggleOptions

  • parameters:
    • checkBox: (typeof object)

      The checkbox object to toggle the selection on.

  • 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

    Nothing

  • type

    Function

• dojox.atom.widget.FeedEntryViewer._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.FeedEntryViewer.setFieldValidity

  • parameters:
    • field: (typeof string)

      The field name to set the valid parameter on.  Such as 'content', 'id', etc.

    • isValid: (typeof boolean)

      Flag denoting if the field is valid or not.

  • summary

    Function to set whether a field in the view is valid and displayable.

  • description

    Function to set whether a field in the view is valid and displayable.
    This is needed for over-riding of the set* functions and customization of how data is displayed in the attach point.
    So if custom implementations use their own display logic, they can still enable the field.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.isFieldValid

  • parameters:
    • field: (typeof string)

      The field name to get the valid parameter of.  Such as 'content', 'id', etc.

  • summary

    Function to return if a displayable field is valid or not

  • description

    Function to return if a displayable field is valid or not

  • return_summary

    boolean denoting if the field is valid and set.

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.getEntry

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.getFeed

  • type

    Function

• dojox.atom.widget.FeedEntryViewer.destroy

  • type

    Function

• dojox.atom.widget.EntryHeader

  • type

    Function

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

    Widget representing a header in a FeedEntryViewer/Editor

  • description

    Widget representing a header in a FeedEntryViewer/Editor

• dojox.atom.widget.EntryHeader.title

  • type

    String

• dojox.atom.widget.EntryHeader.templateString

  • type

    Object

• dojox.atom.widget.EntryHeader.postCreate

  • type

    Function

• dojox.atom.widget.EntryHeader.setListHeader

  • parameters:
    • title: (typeof string)
  • type

    Function

• dojox.atom.widget.EntryHeader.clear

  • type

    Function

• dojox.atom.widget.EntryHeader.destroy

  • type

    Function

• dojox.atom.widget

  • type

    Object

• dojox.atom

  • type

    Object

• dojox

  • type

    Object