dojox/atom/widget/FeedEntryEditor.js

• Provides:

  • dojox.atom.widget.FeedEntryEditor

• Requires:

  • dojox.atom.widget.FeedEntryViewer in common
  • dijit._Widget in common
  • dijit._Templated in common
  • dijit._Container in common
  • dijit.Editor in common
  • dijit.form.TextBox in common
  • dijit.form.SimpleTextarea in common

• dojox.atom.widget.FeedEntryEditor

  • type

    Function

  • chains:
    • dojox.atom.widget.FeedEntryViewer: (prototype)
    • dojox.atom.widget.FeedEntryViewer: (call)
  • summary

    An ATOM feed entry editor that allows viewing of the individual attributes of an entry.

  • description

    An ATOM feed entry editor that allows viewing of the individual attributes of an entry.
    
    
    Flag denoting if the current entry is editable or not.

• dojox.atom.widget.FeedEntryEditor._contentEditor

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._oldContent

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._setObject

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.enableEdit

  • type

    bool

• dojox.atom.widget.FeedEntryEditor._contentEditorCreator

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._editors

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.entryNewButton

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._editable

  • type

    bool

• dojox.atom.widget.FeedEntryEditor.templateString

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.postCreate

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._subscriptions

  • type

    Array

• dojox.atom.widget.FeedEntryEditor.displayOptions.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelTitle.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelAuthors.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelContributors.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelId.innerHTML

• dojox.atom.widget.FeedEntryEditor.close.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelUpdated.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelSummary.innerHTML

• dojox.atom.widget.FeedEntryEditor.feedEntryCheckBoxLabelContent.innerHTML

• dojox.atom.widget.FeedEntryEditor.doNew.innerHTML

• dojox.atom.widget.FeedEntryEditor.edit.innerHTML

• dojox.atom.widget.FeedEntryEditor.save.innerHTML

• dojox.atom.widget.FeedEntryEditor.cancel.innerHTML

• dojox.atom.widget.FeedEntryEditor.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.FeedEntryEditor._editMode

  • type

    bool

• dojox.atom.widget.FeedEntryEditor._toggleEdit

  • summary

    Internal function for toggling/enabling the display of edit mode

  • description

    Internal function for toggling/enabling the display of edit mode

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._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.FeedEntryEditor._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.FeedEntryEditor.setTitle

  • parameters:
    • titleAnchorNode: (typeof DOM)

      The DOM node to attach the title 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 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.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._toLoad

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.entryTitleSelect.value

  • type

    String

• dojox.atom.widget.FeedEntryEditor.setAuthors

  • parameters:
    • authorsAnchorNode: (typeof DOM)

      The DOM node to attach the author 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 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.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._editors.authors

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.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.FeedEntryEditor._editors.contributors

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.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.FeedEntryEditor._editors.id

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.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.FeedEntryEditor._editors.updated

  • type

    Object

• dojox.atom.widget.FeedEntryEditor.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.FeedEntryEditor.entrySummarySelect.value

  • type

    String

• dojox.atom.widget.FeedEntryEditor.setContent

  • parameters:
    • contentAnchorNode: (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 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.
    
    summaryAnchorNode:
    The DOM node to attach the content data to.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.entryContentSelect.value

  • type

    String

• dojox.atom.widget.FeedEntryEditor._createEditor

  • parameters:
    • anchorNode: (typeof DOM)

      The DOM node to attach the editor widget to.

    • node: (typeof DOM)

      An object containing the value to be put into the editor.  This ranges from an anonymous object
      with a value parameter to a dojox.atom.io.model.Content object.

    • multiline: (typeof boolean)

      A boolean indicating whether the content should be multiline (such as a textarea) instead of a
      single line (such as a textbox).

    • rte: (typeof object)

      A boolean indicating whether the content should be a rich text editor widget.

  • summary

    Function to create an appropriate text editor widget based on the given parameters.

  • description

    Function to create an appropriate text editor widget based on the given parameters.

  • return_summary

    Either a widget (for textarea or textbox widgets) or an anonymous object to be used to create a
    rich text area widget.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._switchEditor

  • parameters:
    • event: (typeof object)

      The event generated by the change in the select box on the page.

  • summary

    Function to switch between editor types.

  • description

    Function to switch between a rich text editor and a textarea widget.  Used for title, summary,
    And content when switching between text and html/xhtml content.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.entryContentNode

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._createPeopleEditor

  • parameters:
    • anchorNode: (typeof DOM)

      The node to attach the editor to.

    • node: (typeof DOM)

      An object containing the value to be put into the editor. Typically, this is an
      dojox.atom.io.model.Person object.

  • summary

    Creates a People Editor widget and returns it.

  • description

    Creates a People Editor widget, sets its value, and returns it.

  • return_summary

    A new People Editor object.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.saveEdits

  • summary

    Saves edits submitted when the 'save' button is pressed.

  • description

    Saves edits submitted when the 'save' button is pressed.  Distinguishes between new and existing
    entries and saves appropriately.  Fetches the values of the editors, and, if existing, compares them to
    the existing values and submits the updates, otherwise creates a new entry and posts it as a new entry.

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._new

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._handleSave

  • parameters:
    • entry: (typeof object)

      dojox.atom.io.model.Entry object
      The entry that was saved.
      Location: String
      A URL to be used, not used here, but part of the call back from the AtomIO

    • location: (typeof string)
  • summary

    Function for handling the save of an entry, cleaning up the display after the edit is completed.

  • description

    Function for handling the save of an entry, cleaning up the display after the edit is completed.

  • return_summary

    Nothing.
    Close the editor and revert out.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.cancelEdits

  • summary

    Cancels edits and reverts the editor to its previous state (display mode)

  • description

    Cancels edits and reverts the editor to its previous state (display mode)

  • return_summary

    Nothing.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.clear

  • summary

    Clears the editor, destorys all editors, leaving the editor completely clear

  • description

    Clears the editor, destorys all editors, leaving the editor completely clear

  • type

    Function

• dojox.atom.widget.FeedEntryEditor.clearEditors

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._enforceXhtml

  • parameters:
    • html: (typeof string)

      HTML string to be enforced as xhtml.

  • summary

    Function for cleaning up/enforcing the XHTML standard in HTML returned from the editor2 widget.

  • description

    Function for cleaning up/enforcing the XHTML standard in HTML returned from the editor2 widget.

  • return_summary

    string of cleaned up HTML.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._closeTag

  • parameters:
    • xhtml: (typeof string)

      String XHTML string which needs the closing tag.

    • tag: (typeof string)

      The tag to close.

  • summary

    Function for closing tags in a text of HTML/XHTML

  • description

    Function for closing tags in a text of HTML/XHTML

  • return_summary

    string of cleaned up HTML.
    
    NOTE:  Probably should redo this function in a more efficient way.  This could get expensive.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._toggleNew

  • summary

    Function to put the editor into a state to create a new entry.

  • description

    Function to put the editor into a state to create a new entry.

  • type

    Function

• dojox.atom.widget.FeedEntryEditor._editors.title

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._editors.summary

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._editors.content

  • type

    Object

• dojox.atom.widget.FeedEntryEditor._displaySections

  • summary

    Function to display the appropriate sections based on validity.

  • description

    Function to display the appropriate sections based on validity.

  • type

    Function

• dojox.atom.widget.PeopleEditor

  • 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 editor for dojox.atom.io.model.Person objects.

  • description

    An editor for dojox.atom.io.model.Person objects.  Displays multiple rows for the respective arrays
    of people.  Can add/remove rows on the fly.

• dojox.atom.widget.PeopleEditor.templateString

  • type

    Object

• dojox.atom.widget.PeopleEditor._rows

  • type

    Array

• dojox.atom.widget.PeopleEditor._editors

  • type

    Array

• dojox.atom.widget.PeopleEditor._index

  • type

    Number

• dojox.atom.widget.PeopleEditor._numRows

  • type

    Number

• dojox.atom.widget.PeopleEditor.postCreate

  • type

    Function

• dojox.atom.widget.PeopleEditor.destroy

  • type

    Function

• dojox.atom.widget.PeopleEditor._createEditors

  • parameters:
    • name: (typeof string)

      The name of this Person.

    • email: (typeof string)

      The email of this Person.

    • uri: (typeof string)

      The Person's URI.

    • index: (typeof int)

      The row index to use for this Person.

    • widgetName: (typeof string)
  • summary

    creates editor boxes (textbox widgets) for the individual values of a Person.

  • description

    creates editor boxes (textbox widgets) for the individual values of a Person.

  • type

    Function

• dojox.atom.widget.PeopleEditor._createEditor

  • parameters:
    • value: (typeof string)

      The initial value of the textbox

    • id: (typeof string)

      The id the textbox should have.

    • name: (typeof string)

      The text to put in the label element for this textbox.

    • labelNode: (typeof DOM)

      The node to attach the label to.

    • node: (typeof DOM)

      The node to attach the editor rows to.

  • summary

    Creates an individual editor widget (textbox) for a value.

  • description

    Creates an individual editor widget (textbox) for a value.

  • return_summary

    Editor widget.

  • type

    Function

• dojox.atom.widget.PeopleEditor._removeEditor

  • parameters:
    • event: (typeof object)

      The event generated when the remove button is pressed on the page.

  • summary

    Removes a Person from our list of editors.

  • description

    Removes a Person from our list of editors by removing the block of editors that
    make up that Person.

  • type

    Function

• dojox.atom.widget.PeopleEditor._add

  • summary

    Adds a new block of blank editors to represent a Person.

  • description

    Adds a new block of blank editors to represent a Person.

  • type

    Function

• dojox.atom.widget.PeopleEditor.getValues

  • summary

    Gets the values of this editor in an array.

  • description

    Gets the values of this editor in an array, with each Person as an object within the array.

  • return_summary

    An array of anonymous objects representing dojox.atom.io.model.Persons.

  • type

    Function

• dojox.atom.widget

  • type

    Object

• dojox.atom

  • type

    Object

• dojox

  • type

    Object