FLUID-1048: Simple Reorderer API function should include orderChangedCallback in options

Metadata

Source
FLUID-1048
Type
Sub-task
Priority
Blocker
Status
Closed
Resolution
Fixed
Assignee
Michelle D'Souza
Reporter
Anastasia Cheetham
Created
2008-07-28T13:54:26.000-0400
Updated
2009-06-03T13:43:47.000-0400
Versions
  1. 0.1
  2. 0.3
  3. 0.4beta1
  4. 0.4
Fixed Versions
  1. 0.5beta1
Component
  1. Reorderer

Description

Currently, the various simple Reorderer functions (reorderList(), reorderGrid() and reorderLayout()) accept the orderChangedCallback function as a parameter, in addition to the options object.

However, the general convention that has been emerging with our APIs is that required items are parameters to functions, and anything optional is encompassed by the options object.

If we wish for these simple Reorderer functions to be in harmony with this API convention, then the orderChangedCallback parameter should become part of the options object.

dev-iteration41

Comments

  • Colin Clark commented 2008-07-31T16:35:01.000-0400

    We need to work out a reasonable set of API conventions for every component. This will likely include a central point where callbacks can be registered. As a result, we probably won't fix this issue in the style described.

  • Anastasia Cheetham commented 2008-08-19T12:47:43.000-0400

    In the interest of consistency, both the itemSelector and the orderChangedCallback should be moved into the options. The itemSelector concept should be conveyed using the 'selectors' option.

  • Michelle D'Souza commented 2008-08-20T15:11:42.000-0400

    reorderLayout now has default selectors for 'columns', 'modules', and 'lockedModules'.

    All three of reorderList, reorderGrid and reorderLayout now take 2 parameters - the container and options.