Skip to content

Commit

Permalink
Dijit: use MIDs rather than global variables in summaries and descrip…
Browse files Browse the repository at this point in the history
…tions, so that the hyperlinks work. Refs #13101 !strict
  • Loading branch information
wkeese committed Jul 24, 2012
1 parent 48965f0 commit 8ca48ef
Show file tree
Hide file tree
Showing 76 changed files with 208 additions and 206 deletions.
6 changes: 3 additions & 3 deletions Calendar.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ define([
// Provides keyboard navigation of calendar.
// description:
// Called from _onKeyDown() to handle keypress on a stand alone Calendar,
// and also from `dijit.form._DateTimeTextBox` to pass a keydown event
// from the `dijit.form.DateTextBox` to be handled in this widget
// and also from `dijit/form/_DateTimeTextBox` to pass a keydown event
// from the `dijit/form/DateTextBox` to be handled in this widget
// returns:
// False if the key was recognized as a navigation key,
// to indicate that the event was handled by Calendar and shouldn't be propagated
Expand Down Expand Up @@ -222,7 +222,7 @@ define([
// summary:
// Deprecated. Notification that a date cell was selected. It may be the same as the previous value.
// description:
// Formerly used by `dijit.form._DateTimeTextBox` (and thus `dijit.form.DateTextBox`)
// Formerly used by `dijit/form/_DateTimeTextBox` (and thus `dijit/form/DateTextBox`)
// to get notification when the user has clicked a date. Now onExecute() (above) is used.
// tags:
// protected
Expand Down
2 changes: 1 addition & 1 deletion CalendarLite.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ define([
// description:
// A simple GUI for choosing a date in the context of a monthly calendar.
// This widget can't be used in a form because it doesn't serialize the date to an
// `<input>` field. For a form element, use dijit.form.DateTextBox instead.
// `<input>` field. For a form element, use dijit/form/DateTextBox instead.
//
// Note that the parser takes all dates attributes passed in the
// [RFC 3339 format](http://www.faqs.org/rfcs/rfc3339.html), e.g. `2005-06-30T08:05:00-07:00`
Expand Down
2 changes: 1 addition & 1 deletion ColorPalette.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ var ColorPalette = declare("dijit.ColorPalette", [_Widget, _TemplatedMixin, _Pal
ColorPalette._Color = declare("dijit._Color", Color, {
// summary:
// Object associated with each cell in a ColorPalette palette.
// Implements dijit.Dye.
// Implements dijit/Dye.

// Template for each cell in normal (non-high-contrast mode). Each cell contains a wrapper
// node for showing the border (called dijitPaletteImg for back-compat), and dijitColorPaletteSwatch
Expand Down
6 changes: 3 additions & 3 deletions Dialog.js
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,12 @@ define([

// _firstFocusItem: [private readonly] DomNode
// The pointer to the first focusable node in the dialog.
// Set by `dijit._DialogMixin._getFocusItems`.
// Set by `dijit/_DialogMixin._getFocusItems()`.
_firstFocusItem: null,

// _lastFocusItem: [private readonly] DomNode
// The pointer to which node has focus prior to our dialog.
// Set by `dijit._DialogMixin._getFocusItems`.
// Set by `dijit/_DialogMixin._getFocusItems()`.
_lastFocusItem: null,

// doLayout: [protected] Boolean
Expand Down Expand Up @@ -553,7 +553,7 @@ define([
// If the specified dialog isn't open then does nothing.
//
// Caller is responsible for either setting display:none on the dialog domNode,
// or calling dijit.popup.hide(), or removing it from the page DOM.
// or calling dijit/popup.hide(), or removing it from the page DOM.

if(ds[ds.length-1].dialog == dialog){
// Removing the top (or only) dialog in the stack, return focus
Expand Down
6 changes: 3 additions & 3 deletions Editor.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ define([
// the options available in the toolbar. Content generation may vary across
// browsers, and clipboard operations may have different results, to name
// a few limitations. Note: this widget should not be used with the HTML
// &lt;TEXTAREA&gt; tag -- see dijit._editor.RichText for details.
// &lt;TEXTAREA&gt; tag -- see dijit/_editor/RichText for details.

// plugins: [const] Object[]
// A list of plugin names (as strings) or instances (as objects)
Expand Down Expand Up @@ -218,7 +218,7 @@ define([

resize: function(size){
// summary:
// Resize the editor to the specified size, see `dijit.layout._LayoutWidget.resize`
// Resize the editor to the specified size, see `dijit/layout/_LayoutWidget.resize()`
if(size){
// we've been given a height/width for the entire editor (toolbar + contents), calls layout()
// to split the allocated size between the toolbar and the contents
Expand All @@ -233,7 +233,7 @@ define([
},
layout: function(){
// summary:
// Called from `dijit.layout._LayoutWidget.resize`. This shouldn't be called directly
// Called from `dijit/layout/_LayoutWidget.resize()`. This shouldn't be called directly
// tags:
// protected

Expand Down
2 changes: 1 addition & 1 deletion ProgressBar.js
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ return declare("dijit.ProgressBar", [_Widget, _TemplatedMixin], {

// name: String
// this is the field name (for a form) if set. This needs to be set if you want to use
// this widget in a dijit.form.Form widget (such as dijit.Dialog)
// this widget in a dijit/form/Form widget (such as dijit/Dialog)
name: '',

templateString: template,
Expand Down
2 changes: 1 addition & 1 deletion TitlePane.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ return declare("dijit.TitlePane", [ContentPane, _TemplatedMixin, _CssStateMixin]
// description:
// An accessible container with a title Heading, and a content
// section that slides open and closed. TitlePane is an extension to
// `dijit.layout.ContentPane`, providing all the useful content-control aspects from it.
// `dijit/layout/ContentPane`, providing all the useful content-control aspects from it.
//
// example:
// | // load a TitlePane from remote file:
Expand Down
51 changes: 27 additions & 24 deletions Tooltip.js
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,8 @@ define([
dijit.showTooltip = function(innerHTML, aroundNode, position, rtl, textDir){
// summary:
// Static method to display tooltip w/specified contents in specified position.
// See description of dijit.Tooltip.defaultPosition for details on position parameter.
// If position is not specified then dijit.Tooltip.defaultPosition is used.
// See description of dijit/Tooltip.defaultPosition for details on position parameter.
// If position is not specified then dijit/Tooltip.defaultPosition is used.
// innerHTML: String
// Contents of the tooltip
// aroundNode: place.__Rectangle
Expand Down Expand Up @@ -311,7 +311,7 @@ define([
connectId: [],

// position: String[]
// See description of `dijit.Tooltip.defaultPosition` for details on position parameter.
// See description of `dijit/Tooltip.defaultPosition` for details on position parameter.
position: [],

// selector: String?
Expand Down Expand Up @@ -506,28 +506,31 @@ define([
Tooltip.show = dijit.showTooltip; // export function through module return value
Tooltip.hide = dijit.hideTooltip; // export function through module return value

// dijit.Tooltip.defaultPosition: String[]
// This variable controls the position of tooltips, if the position is not specified to
// the Tooltip widget or *TextBox widget itself. It's an array of strings with the values
// possible for `dijit/place::around()`. The recommended values are:
//
// - before-centered: centers tooltip to the left of the anchor node/widget, or to the right
// in the case of RTL scripts like Hebrew and Arabic
// - after-centered: centers tooltip to the right of the anchor node/widget, or to the left
// in the case of RTL scripts like Hebrew and Arabic
// - above-centered: tooltip is centered above anchor node
// - below-centered: tooltip is centered above anchor node
//
// The list is positions is tried, in order, until a position is found where the tooltip fits
// within the viewport.
//
// Be careful setting this parameter. A value of "above-centered" may work fine until the user scrolls
// the screen so that there's no room above the target node. Nodes with drop downs, like
// DropDownButton or FilteringSelect, are especially problematic, in that you need to be sure
// that the drop down and tooltip don't overlap, even when the viewport is scrolled so that there
// is only room below (or above) the target node, but not both.
Tooltip.defaultPosition = ["after-centered", "before-centered"];


/*=====
lang.mixin(Tooltip, {
// defaultPosition: String[]
// This variable controls the position of tooltips, if the position is not specified to
// the Tooltip widget or *TextBox widget itself. It's an array of strings with the values
// possible for `dijit/place.around()`. The recommended values are:
//
// - before-centered: centers tooltip to the left of the anchor node/widget, or to the right
// in the case of RTL scripts like Hebrew and Arabic
// - after-centered: centers tooltip to the right of the anchor node/widget, or to the left
// in the case of RTL scripts like Hebrew and Arabic
// - above-centered: tooltip is centered above anchor node
// - below-centered: tooltip is centered above anchor node
//
// The list is positions is tried, in order, until a position is found where the tooltip fits
// within the viewport.
//
// Be careful setting this parameter. A value of "above-centered" may work fine until the user scrolls
// the screen so that there's no room above the target node. Nodes with drop downs, like
// DropDownButton or FilteringSelect, are especially problematic, in that you need to be sure
// that the drop down and tooltip don't overlap, even when the viewport is scrolled so that there
// is only room below (or above) the target node, but not both.
});
=====*/
return Tooltip;
});
10 changes: 5 additions & 5 deletions TooltipDialog.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,21 +37,21 @@ define([
// autofocus: Boolean
// A Toggle to modify the default focus behavior of a Dialog, which
// is to focus on the first dialog element after opening the dialog.
// False will disable autofocusing. Default: true
// False will disable autofocusing. Default: true.
autofocus: true,

// baseClass: [protected] String
// The root className to use for the various states of this widget
baseClass: "dijitTooltipDialog",

// _firstFocusItem: [private] [readonly] DomNode
// _firstFocusItem: [private readonly] DomNode
// The pointer to the first focusable node in the dialog.
// Set by `dijit._DialogMixin._getFocusItems`.
// Set by `dijit/_DialogMixin._getFocusItems()`.
_firstFocusItem: null,

// _lastFocusItem: [private] [readonly] DomNode
// _lastFocusItem: [private readonly] DomNode
// The pointer to which node has focus prior to our dialog.
// Set by `dijit._DialogMixin._getFocusItems`.
// Set by `dijit/_DialogMixin._getFocusItems()`.
_lastFocusItem: null,

templateString: template,
Expand Down
12 changes: 6 additions & 6 deletions Tree.js
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
query: null,

// label: [deprecated] String
// Deprecated. Use dijit.tree.ForestStoreModel directly instead.
// Deprecated. Use dijit/tree/ForestStoreModel directly instead.
// Used in conjunction with query parameter.
// If a query is specified (rather than a root node id), and a label is also specified,
// then a fake root node is created and displayed, with this label.
Expand Down Expand Up @@ -612,8 +612,8 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {

// dndController: [protected] Function|String
// Class to use as as the dnd controller. Specifying this class enables DnD.
// Generally you should specify this as dijit.tree.dndSource.
// Setting of dijit.tree._dndSelector handles selection only (no actual DnD).
// Generally you should specify this as dijit/tree/dndSource.
// Setting of dijit/tree/_dndSelector handles selection only (no actual DnD).
dndController: _dndSelector,

// parameters to pull off of the tree and pass on to the dndController as its params
Expand All @@ -622,7 +622,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
//declare the above items so they can be pulled from the tree's markup

// onDndDrop: [protected] Function
// Parameter to dndController, see `dijit.tree.dndSource.onDndDrop`.
// Parameter to dndController, see `dijit/tree/dndSource.onDndDrop()`.
// Generally this doesn't need to be set.
onDndDrop: null,

Expand All @@ -642,7 +642,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
// target: DomNode
// The target TreeNode.rowNode
// source: dojo/dnd/Source
// The source container the nodes were dragged from, perhaps another Tree or a plain dojo.dnd.Source
// The source container the nodes were dragged from, perhaps another Tree or a plain dojo/dnd/Source
// returns: Object[]
// Array of name/value hashes for each new item to be added to the Tree, like:
// | [
Expand All @@ -656,7 +656,7 @@ var Tree = declare("dijit.Tree", [_Widget, _TemplatedMixin], {
=====*/

// onDndCancel: [protected] Function
// Parameter to dndController, see `dijit.tree.dndSource.onDndCancel`.
// Parameter to dndController, see `dijit/tree/dndSource.onDndCancel()`.
// Generally this doesn't need to be set.
onDndCancel: null,

Expand Down
2 changes: 1 addition & 1 deletion WidgetSet.js
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ define([

});

// Add in 1.x compatibility methods to dijit.registry.
// Add in 1.x compatibility methods to dijit/registry.
// These functions won't show up in the API doc but since they are deprecated anyway,
// that's probably for the best.
array.forEach(["forEach", "filter", "byClass", "map", "every", "some"], function(func){
Expand Down
4 changes: 2 additions & 2 deletions _DialogMixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ define([
// description:
// Developer shouldn't override or connect to this method;
// it's a private communication device between the TooltipDialog
// and the thing that opened it (ex: `dijit.form.DropDownButton`)
// and the thing that opened it (ex: `dijit/form/DropDownButton`)
// type:
// protected
},
Expand All @@ -41,7 +41,7 @@ define([
// description:
// Developer shouldn't override or connect to this method;
// it's a private communication device between the TooltipDialog
// and the thing that opened it (ex: `dijit.form.DropDownButton`)
// and the thing that opened it (ex: `dijit/form/DropDownButton`)
// type:
// protected
},
Expand Down
6 changes: 3 additions & 3 deletions _HasDropDown.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ define([
// toggle the drop down.
//
// The if(has("touch") is necessary since IE and desktop safari get spurious onclick events
// when there are nested tables (specifically, clicking on a table that holds a dijit.form.Select,
// when there are nested tables (specifically, clicking on a table that holds a dijit/form/Select,
// but not on the Select itself, causes an onclick event on the Select)
this._onDropDownMouseDown(e);
this._onDropDownMouseUp(e);
Expand Down Expand Up @@ -369,7 +369,7 @@ define([
// Opens the dropdown for this widget. To be called only when this.dropDown
// has been created and is ready to display (ie, it's data is loaded).
// returns:
// return value of dijit.popup.open()
// return value of dijit/popup.open()
// tags:
// protected

Expand All @@ -380,7 +380,7 @@ define([

// Prepare our popup's height and honor maxHeight if it exists.

// TODO: isn't maxHeight dependent on the return value from dijit.popup.open(),
// TODO: isn't maxHeight dependent on the return value from dijit/popup.open(),
// ie, dependent on how much space is available (BK)

if(!this._preparedNode){
Expand Down
2 changes: 1 addition & 1 deletion _OnDijitClickMixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ define([
// A handle that can be passed to `disconnect` in order to disconnect before
// the widget is destroyed.
// example:
// | var btn = new dijit.form.Button();
// | var btn = new Button();
// | // when foo.bar() is called, call the listener we're going to
// | // provide in the scope of btn
// | btn.connect(foo, "bar", function(){
Expand Down
12 changes: 6 additions & 6 deletions _TimePicker.js
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ define([
// every clickable element in the time picker increases.
// Set in local time, without a time zone.
// Example: `T00:15:00` creates 15 minute increments
// Must divide dijit._TimePicker.visibleIncrement evenly
// Must divide dijit/_TimePicker.visibleIncrement evenly
clickableIncrement: "T00:15:00",

// visibleIncrement: String
Expand Down Expand Up @@ -449,8 +449,8 @@ define([

handleKey: function(/*Event*/ e){
// summary:
// Called from `dijit.form._DateTimeTextBox` to pass a keypress event
// from the `dijit.form.TimeTextBox` to be handled in this widget
// Called from `dijit/form/_DateTimeTextBox` to pass a keypress event
// from the `dijit/form/TimeTextBox` to be handled in this widget
// tags:
// protected
if(e.keyCode == keys.DOWN_ARROW || e.keyCode == keys.UP_ARROW){
Expand Down Expand Up @@ -500,15 +500,15 @@ define([
/*=====
TimePicker.__Constraints = declare(locale.__FormatOptions, {
// clickableIncrement: String
// See `dijit._TimePicker.clickableIncrement`
// See `dijit/_TimePicker.clickableIncrement`
clickableIncrement: "T00:15:00",
// visibleIncrement: String
// See `dijit._TimePicker.visibleIncrement`
// See `dijit/_TimePicker.visibleIncrement`
visibleIncrement: "T01:00:00",
// visibleRange: String
// See `dijit._TimePicker.visibleRange`
// See `dijit/_TimePicker.visibleRange`
visibleRange: "T05:00:00"
});
=====*/
Expand Down
10 changes: 5 additions & 5 deletions _Widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -317,8 +317,8 @@ var _Widget = declare("dijit._Widget", [_WidgetBase, _OnDijitClickMixin, _FocusM
onShow: function(){
// summary:
// Called when this widget becomes the selected pane in a
// `dijit.layout.TabContainer`, `dijit.layout.StackContainer`,
// `dijit.layout.AccordionContainer`, etc.
// `dijit/layout/TabContainer`, `dijit/layout/StackContainer`,
// `dijit/layout/AccordionContainer`, etc.
//
// Also called to indicate display of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`.
// tags:
Expand All @@ -328,8 +328,8 @@ var _Widget = declare("dijit._Widget", [_WidgetBase, _OnDijitClickMixin, _FocusM
onHide: function(){
// summary:
// Called when another widget becomes the selected pane in a
// `dijit.layout.TabContainer`, `dijit.layout.StackContainer`,
// `dijit.layout.AccordionContainer`, etc.
// `dijit/layout/TabContainer`, `dijit/layout/StackContainer`,
// `dijit/layout/AccordionContainer`, etc.
//
// Also called to indicate hide of a `dijit.Dialog`, `dijit.TooltipDialog`, or `dijit.TitlePane`.
// tags:
Expand All @@ -342,7 +342,7 @@ var _Widget = declare("dijit._Widget", [_WidgetBase, _OnDijitClickMixin, _FocusM
// up from a DateTextBox), and it is hidden.
// This is called from the dijit.popup code, and should not be called directly.
//
// Also used as a parameter for children of `dijit.layout.StackContainer` or subclasses.
// Also used as a parameter for children of `dijit/layout/StackContainer` or subclasses.
// Callback if a user tries to close the child. Child will be closed if this function returns true.
// tags:
// extension
Expand Down
Loading

0 comments on commit 8ca48ef

Please sign in to comment.