dojox/editor/plugins/TablePlugins.js

• Provides:

  • dojox.editor.plugins.TablePlugins

• Requires:

  • dijit.form.Button in common
  • dijit.Dialog in common
  • dijit.form.TextBox in common
  • dijit.form.FilteringSelect in common
  • dijit._editor._Plugin in common
  • dijit._editor.selection in common
  • dijit.Menu in common
  • dijit.ColorPalette in common
  • dojox.widget.ColorPicker in common
  • dojo.i18n in common

• dojox.editor.plugins._TableHandler

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    A global object that handles common tasks for all the plugins. Since
    there are several plugins that are all calling common methods, it's preferable
    that they call a centralized location that either has a set variable or a
    timeout to only repeat code-heavy calls when necessary.
    
    
    
    Using custom undo for all browsers.

• dojox.editor.plugins._TableHandler.tablesConnected

  • type

    bool

• dojox.editor.plugins._TableHandler.currentlyAvailable

  • type

    bool

• dojox.editor.plugins._TableHandler.alwaysAvailable

  • type

    bool

• dojox.editor.plugins._TableHandler.availableCurrentlySet

  • type

    Object

• dojox.editor.plugins._TableHandler.initialized

  • type

    bool

• dojox.editor.plugins._TableHandler.tableData

  • type

    Object

• dojox.editor.plugins._TableHandler.shiftKeyDown

  • type

    bool

• dojox.editor.plugins._TableHandler.editorDomNode

  • type

    Object

• dojox.editor.plugins._TableHandler.undoEnabled

  • type

    Object

• dojox.editor.plugins._TableHandler.refCount

  • type

    Number

• dojox.editor.plugins._TableHandler.doMixins

  • type

    Function

• dojox.editor.plugins._TableHandler.initialize

  • parameters:
    • editor
  • summary

    Initialize the global handler upon a plugin's first instance of setEditor

  • type

    Function

• dojox.editor.plugins._TableHandler.editor

• dojox.editor.plugins._TableHandler.editor._tablePluginHandler

  • type

    Object

• dojox.editor.plugins._TableHandler.getTableInfo

  • parameters:
    • forceNewData
  • summary

    Gets the table in focus
    Collects info on the table - see return params

  • type

    Function

• dojox.editor.plugins._TableHandler.connectDraggable

  • summary

    Detects drag-n-drop in the editor (could probably be moved to there)
    Currently only checks if item dragged was a TABLE, and removes its align attr
    DOES NOT WORK IN FF - it could - but FF's drag detection is a monster

  • type

    Function

• dojox.editor.plugins._TableHandler.editorDomNode.ondragstart

  • type

    Object

• dojox.editor.plugins._TableHandler.editorDomNode.ondragend

  • type

    Object

• dojox.editor.plugins._TableHandler.onDragStart

  • type

    Function

• dojox.editor.plugins._TableHandler.onDragEnd

  • summary

    Detects that an object has been dragged into place
    Currently, this code is only used for when a table is dragged
    and clears the "align" attribute, so that the table will look
    to be more in the place that the user expected.
    TODO: This code can be used for other things, most
    notably UNDO, which currently is not quite usable.
    This code could also find itself in the Editor code when it is
    complete.

  • type

    Function

• dojox.editor.plugins._TableHandler.editor.window

• dojox.editor.plugins._TableHandler.checkAvailable

  • summary

    For table plugs
    Checking if a table or part of a table has focus so that
    Plugs can change their status

  • type

    Function

• dojox.editor.plugins._TableHandler._prepareTable

  • parameters:
    • tbl
  • type

    Function

• dojox.editor.plugins._TableHandler.getTimeStamp

  • returns

    Fixed the bug that this method always returns the same timestamp

  • type

    Function

• dojox.editor.plugins._TableHandler._tempStoreTableData

  • parameters:
    • type
  • type

    Function

• dojox.editor.plugins._TableHandler._tempAvailability

  • parameters:
    • type
  • type

    Function

• dojox.editor.plugins._TableHandler.connectTableKeys

  • summary

    When a table is in focus, start detecting keys
    Mainly checking for the TAB key so user can tab
    through a table (blocking the browser's desire to
    tab away from teh editor completely)

  • type

    Function

• dojox.editor.plugins._TableHandler.cnKeyDn

  • type

    Object

• dojox.editor.plugins._TableHandler.cnKeyUp

  • type

    Object

• dojox.editor.plugins._TableHandler.disconnectTableKeys

  • type

    Function

• dojox.editor.plugins._TableHandler.onKeyDown

  • parameters:
    • evt
  • type

    Function

• dojox.editor.plugins._TableHandler.stopEvent

  • type

    bool

• dojox.editor.plugins._TableHandler.onKeyUp

  • parameters:
    • evt
  • type

    Function

• dojox.editor.plugins._TableHandler.onDisplayChanged

  • type

    Function

• dojox.editor.plugins._TableHandler.uninitialize

  • parameters:
    • editor: (typeof The)

      editor to detach from.

  • summary

    Function to handle cleaning up of connects
    and such.  It only finally destroys everything once
    all 'references' to it have gone.  As in all plugins
    that called init on it destroyed their refs in their
    cleanup calls.

  • type

    Function

• dojox.editor.plugins.TablePlugins

  • type

    Function

  • chains:
    • dijit._editor._Plugin: (prototype)
    • dijit._editor._Plugin: (call)
  • summary

    A collection of Plugins for inserting and modifying tables in the Editor
    See end of this document for all avaiable plugs
    and dojox/editorPlugins/tests/editorTablePlugs.html for an example
    
    NOT IMPLEMENTED: Not handling cell merge, span or split

• dojox.editor.plugins.TablePlugins.iconClassPrefix

  • type

    String

• dojox.editor.plugins.TablePlugins.useDefaultCommand

  • type

    bool

• dojox.editor.plugins.TablePlugins.buttonClass

  • alias - dijit.form.Button

• dojox.editor.plugins.TablePlugins.commandName

  • type

    String

• dojox.editor.plugins.TablePlugins.label

  • type

    Object

• dojox.editor.plugins.TablePlugins.alwaysAvailable

  • type

    bool

• dojox.editor.plugins.TablePlugins.undoEnabled

  • type

    Object

• dojox.editor.plugins.TablePlugins.onDisplayChanged

  • parameters:
    • withinTable
  • type

    Function

• dojox.editor.plugins.TablePlugins.available

• dojox.editor.plugins.TablePlugins.setEditor

  • parameters:
    • editor
  • type

    Function

• dojox.editor.plugins.TablePlugins.editor

• dojox.editor.plugins.TablePlugins.editor.customUndo

  • type

    Object

• dojox.editor.plugins.TablePlugins._availableTopic

  • type

    Object

• dojox.editor.plugins.TablePlugins.onEditorLoaded

  • type

    Function

• dojox.editor.plugins.TablePlugins.selectTable

  • type

    Function

• dojox.editor.plugins.TablePlugins._initButton

  • type

    Function

• dojox.editor.plugins.TablePlugins.command

• dojox.editor.plugins.TablePlugins.modTable

  • parameters:
    • cmd
    • args
  • summary

    Where each plugin performs its action
    Note: not using execCommand. In spite of their presence in the
    Editor as query-able plugins, I was not able to find any evidence
    that they are supported (especially in NOT IE). If they are
    supported in other browsers, it may help with the undo problem.

  • type

    Function

• dojox.editor.plugins.TablePlugins.begEdit

  • type

    Function

• dojox.editor.plugins.TablePlugins.valBeforeUndo

  • type

    Object

• dojox.editor.plugins.TablePlugins.endEdit

  • type

    Function

• dojox.editor.plugins.TablePlugins.makeColumnsEven

  • summary

    After changing column amount, change widths to
    keep columns even
    
    the timeout helps prevent an occasional snafu

  • type

    Function

• dojox.editor.plugins.TablePlugins.getTableInfo

  • parameters:
    • forceNewData
  • summary

    Gets the table in focus
    Collects info on the table - see return params

  • type

    Function

• dojox.editor.plugins.TablePlugins._makeTitle

  • parameters:
    • str
  • type

    Function

• dojox.editor.plugins.TablePlugins.getSelectedCells

  • summary

    Gets the selected cells from the passed table
    Returns: array of TDs or empty array

  • type

    Function

• dojox.editor.plugins.TablePlugins.updateState

  • summary

    Over-ride for button state control for disabled to work.

  • type

    Function

• dojox.editor.plugins.TablePlugins.destroy

  • summary

    Over-ridden destroy to do some cleanup.

  • type

    Function

• dojox.editor.plugins.TableContextMenu

  • type

    Function

  • chains:
    • dojox.editor.plugins.TablePlugins: (prototype)
    • dojox.editor.plugins.TablePlugins: (call)
  • summary

    Initialize certain plugins

• dojox.editor.plugins.TableContextMenu.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Initialize certain plugins

• dojox.editor.plugins.TableContextMenu.destroy

  • summary

    Over-ride to do menu cleanup.

  • type

    Function

• dojox.editor.plugins.TableContextMenu._initButton

  • type

    Function

• dojox.editor.plugins.TableContextMenu.button.domNode.display

  • type

    String

• dojox.editor.plugins.TableContextMenu._createContextMenu

  • type

    Function

• dojox.editor.plugins.TableContextMenu.menu

• dojox.editor.plugins.InsertTable

  • type

    Function

  • chains:
    • dojox.editor.plugins.TablePlugins: (prototype)
    • dojox.editor.plugins.TablePlugins: (call)

• dojox.editor.plugins.InsertTable.alwaysAvailable

  • type

    Object

• dojox.editor.plugins.InsertTable.modTable

  • type

    Function

• dojox.editor.plugins.ModifyTable

  • type

    Function

  • chains:
    • dojox.editor.plugins.TablePlugins: (prototype)
    • dojox.editor.plugins.TablePlugins: (call)

• dojox.editor.plugins.ModifyTable.modTable

  • type

    Function

• dojox.editor.plugins._CellColorDropDown

  • type

    Function

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

    A smple widget that uses/creates a dropdown with a dojox.widget.ColorPicker.  Also provides
    passthroughs to the value of the color picker and convenient hook points.

  • tags:

• dojox.editor.plugins._CellColorDropDown.templateString

  • type

    String

  • summary

    The template used to create the ColorPicker.

• dojox.editor.plugins._CellColorDropDown.widgetsInTemplate

  • type

    Boolean

  • summary

    Flag denoting widgets are contained in the template.

• dojox.editor.plugins._CellColorDropDown.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Constructor over-ride so that the translated strings are mixsed in so
    the template fills out.

• dojox.editor.plugins._CellColorDropDown.startup

  • summary

    Over-ride of startup to do the basic connect setups and such.

  • type

    Function

• dojox.editor.plugins._CellColorDropDown._setValueAttr

  • parameters:
    • value: (typeof String)

      The value to set in the color picker

    • priorityChange: (typeof Value)

      to indicate whether or not to trigger an onChange event.

  • summary

    Passthrough function for the color picker value.

  • type

    Function

• dojox.editor.plugins._CellColorDropDown._getValueAttr

  • summary

    Passthrough function for the color picker value.

  • type

    Function

• dojox.editor.plugins._CellColorDropDown.setColor

  • parameters:
    • color: (typeof String)
  • type

    Function

• dojox.editor.plugins._CellColorDropDown.onChange

  • parameters:
    • value: (typeof String)

      The value from the color picker.

  • summary

    Hook point to get the value when the color picker value is selected.

  • type

    Function

• dojox.editor.plugins._CellColorDropDown.onCancel

  • summary

    Hook point to get when the dialog is canceled.

  • type

    Function

• dojox.editor.plugins.ColorTableCell

  • type

    Function

  • chains:
    • dojox.editor.plugins.TablePlugins: (prototype)
    • dojox.editor.plugins.TablePlugins: (call)
  • summary

    Initialize ColorTableCell plugin

• dojox.editor.plugins.ColorTableCell.constructor

  • constructor - constructor
  • type

    Function

  • summary

    Initialize ColorTableCell plugin

• dojox.editor.plugins.ColorTableCell._initButton

  • type

    Function

• dojox.editor.plugins.ColorTableCell.command

• dojox.editor.plugins.ColorTableCell.label

  • type

    Object

• dojox.editor.plugins.ColorTableCell.modTable

  • parameters:
    • cmd
    • args
  • type

    Function

• dojox.editor.plugins.ColorTableCell.closable

  • type

    Object

• dojox.editor.plugins.ColorTableCell.buttonClass

• dojox.editor.plugins.ColorTableCell.dropDown

• dojox.editor.plugins.EditorTableDialog

  • type

    Function

  • chains:
    • dijit.Dialog: (prototype)
    • dijit.Dialog: (call)
  • summary

    Dialog box with options for table creation

• dojox.editor.plugins.EditorTableDialog.baseClass

  • type

    String

• dojox.editor.plugins.EditorTableDialog.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins.EditorTableDialog.templateString

  • type

    Object

• dojox.editor.plugins.EditorTableDialog.postMixInProperties

  • type

    Function

• dojox.editor.plugins.EditorTableDialog.postCreate

  • type

    Function

• dojox.editor.plugins.EditorTableDialog.onInsert

  • type

    Function

• dojox.editor.plugins.EditorTableDialog.onCancel

  • summary

    Function to clean up memory so that the dialog is destroyed
    when closed.

  • type

    Function

• dojox.editor.plugins.EditorTableDialog.onBuildTable

  • parameters:
    • tableText
  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog

  • type

    Function

  • chains:
    • dijit.Dialog: (prototype)
    • dijit.Dialog: (call)
  • summary

    Dialog box with options for editing a table

• dojox.editor.plugins.EditorModifyTableDialog.baseClass

  • type

    String

• dojox.editor.plugins.EditorModifyTableDialog.widgetsInTemplate

  • type

    Object

• dojox.editor.plugins.EditorModifyTableDialog.table

  • type

    Object

• dojox.editor.plugins.EditorModifyTableDialog.tableAtts

  • type

    Object

• dojox.editor.plugins.EditorModifyTableDialog.templateString

  • type

    Object

• dojox.editor.plugins.EditorModifyTableDialog.postMixInProperties

  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.postCreate

  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog._cleanupWidgets

  • type

    Array

• dojox.editor.plugins.EditorModifyTableDialog.setBrdColor

  • parameters:
    • color
  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.brdColor

• dojox.editor.plugins.EditorModifyTableDialog.setBkColor

  • parameters:
    • color
  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.bkColor

• dojox.editor.plugins.EditorModifyTableDialog.onSet

  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.onCancel

  • summary

    Function to clean up memory so that the dialog is destroyed
    when closed.

  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.onSetTable

  • parameters:
    • tableText
  • type

    Function

• dojox.editor.plugins.EditorModifyTableDialog.destroy

  • summary

    Cleanup function.

  • type

    Function

• dojox.editor.plugins

  • type

    Object

• dojox.editor

  • type

    Object

• dojox

  • type

    Object