Permalink
Browse files

documentable

  • Loading branch information...
justinbmeyer committed Nov 29, 2011
1 parent 8ecce74 commit 229cd237b73b28f4961c0a863da1d818305b09e4
0 README
No changes.
@@ -0,0 +1,3 @@
@page Mxui Mxui
@parent index 6
This is for mxui
@@ -7,6 +7,9 @@ steal('mxui/layout/table_scroll',
.then('./views/th.ejs','./views/init.ejs','./views/list.ejs')
.then(function($){
/**
* @class Mxui.Data.Grid
* @parent Mxui
*
* A simple data grid that is paginate-able and sortable.
*
* ## Use
@@ -8,7 +8,7 @@ steal( 'jquery/controller',
/**
* @class Mxui.Data.Tree
*
* @parent Mxui
* API
*
* // create
@@ -40,7 +40,11 @@ steal('jquery/event').then(function($){
focusBubble = 'focusbubble',
blurBubble = 'blurbubble';
}
/**
* @class jQuery.event.special.selectin
* @parent Mxui
* @param {Object} handleObj
*/
$.event.special.selectin = {
add: function( handleObj ) {
if(handleObj.selector){
@@ -2,10 +2,10 @@ steal('jquery/controller', 'jquery/lang/json', 'mxui/util/scrollbar_width', 'jqu
.then('./controllers/dropdown_controller','./controllers/selectable_controller',function() {
/**
* @tag home
* @class Combobox
* @class Mxui.Form.Combobox
* @plugin mxui/form/combobox
* @test mxui/form/combobox/funcunit.html
* @parent Mxui
*
* Combobox progressively enhances an <input> field. This constructor accepts an Object of [Mxui.Combobox.static.defaults | options] used to customize the Combobox.
*
@@ -11,6 +11,8 @@
steal(function($){
/**
* @class Mxui.Layout.Bgiframe
* @parent Mxui
* The bgiframe is chainable and applies the iframe hack to get
* around zIndex issues in IE6. It will only apply itself in IE6
* and adds a class to the iframe called 'bgiframe'. The iframe
@@ -35,34 +37,34 @@ steal(function($){
* <div><iframe class="bgiframe".../><p>Paragraph</p></div>
*
* @param Map settings Optional settings to configure the iframe.
* @option String|Number top The iframe must be offset to the top
* - String|Number top The iframe must be offset to the top
* by the width of the top border. This should be a negative
* number representing the border-top-width. If a number is
* is used here, pixels will be assumed. Otherwise, be sure
* to specify a unit. An expression could also be used.
* By default the value is "auto" which will use an expression
* to get the border-top-width if it is in pixels.
* @option String|Number left The iframe must be offset to the left
* - String|Number left The iframe must be offset to the left
* by the width of the left border. This should be a negative
* number representing the border-left-width. If a number is
* is used here, pixels will be assumed. Otherwise, be sure
* to specify a unit. An expression could also be used.
* By default the value is "auto" which will use an expression
* to get the border-left-width if it is in pixels.
* @option String|Number width This is the width of the iframe. If
* - String|Number width This is the width of the iframe. If
* a number is used here, pixels will be assume. Otherwise, be sure
* to specify a unit. An experssion could also be used.
* By default the value is "auto" which will use an experssion
* to get the offsetWidth.
* @option String|Number height This is the height of the iframe. If
* - String|Number height This is the height of the iframe. If
* a number is used here, pixels will be assume. Otherwise, be sure
* to specify a unit. An experssion could also be used.
* By default the value is "auto" which will use an experssion
* to get the offsetHeight.
* @option Boolean opacity This is a boolean representing whether or not
* - Boolean opacity This is a boolean representing whether or not
* to use opacity. If set to true, the opacity of 0 is applied. If
* set to false, the opacity filter is not applied. Default: true.
* @option String src This setting is provided so that one could change
* - String src This setting is provided so that one could change
* the src of the iframe to whatever they need.
* Default: "javascript:false;"
*
@@ -3,7 +3,8 @@ steal('jquery/controller',
'mxui/layout/bgiframe',
'mxui/layout/fill').then(function($){
/**
* @tag mxui
* @class Mxui.Layout.Block
* @parent Mxui
* @plugin mxui/block
* @test mxui/block/funcunit.html
*
@@ -36,7 +36,7 @@ steal('jquery/dom/dimensions', 'jquery/event/resize').then(function( $ ) {
},
/**
* @function jQuery.fn.mxui_layout_fill
* @parent mxui
* @parent Mxui
* Fills a parent element's hieght with the jQuery element.
*
* @param {Object} options
@@ -201,7 +201,11 @@ steal('jquery/dom/dimensions').then(function ($) {
return fitAbove;
}
/**
* @function $.fn.mxui_layout_fit
* @parent Mxui
* @param {Object} options
*/
$.fn.mxui_layout_fit = function (options) {
// check if we have all necessary data before doing the work
var of = options.of,
@@ -1,5 +1,9 @@
steal('jquery/controller','mxui/positionable').then(function($){
Mxui.Positionable("Mxui.Modal", {
steal('jquery/controller','mxui/layout/positionable').then(function($){
/**
* @class Mxui.Layout.Modal
* @parent Mxui
*/
Mxui.Layout.Positionable("Mxui.Layout.Modal", {
defaults: {
my: 'center center',
at: 'center center',
@@ -18,8 +18,11 @@ steal('jquery/controller',
})
$.Controller.extend("Mxui.Layout.Resize",{
/**
* @class Mxui.Layout.Resize
* @parent Mxui
*/
$.Controller("Mxui.Layout.Resize",{
defaults : {
minHeight: 10,
minWidth: 10,
@@ -2,7 +2,8 @@ steal('jquery/controller', 'jquery/event/drag/limit', 'jquery/dom/dimensions', '
.then('./split.css').then(function( $ ) {
/**
*
* @class Mxui.Layout.Split
* @parent Mxui
* MXUI.Layout.Split is a splitter control that will split two or more elements
* and allow the end-user to size the elements using a 'splitter bar'.
*
@@ -25,7 +26,7 @@ steal('jquery/controller', 'jquery/event/drag/limit', 'jquery/dom/dimensions', '
* E.g. <div class='collapsible'><div class='split'><div class='collapsible'> Only one or the other can be collapsible.
*
*/
$.Controller.extend("MXUI.Layout.Split", {
$.Controller.extend("Mxui.Layout.Split", {
defaults: {
active: "active",
hover: "split-hover",
@@ -10,7 +10,7 @@ var setWidths = function(cells, firstWidths){
/**
* @class Mxui.Layout.TableScroll
*
* @parent Mxui
* Makes a table body elements under a table
* header. For example if you have the following html:
*
24 mxui.js
@@ -0,0 +1,24 @@
steal(
'mxui/data/grid',
'mxui/data/tree',
'mxui/layout/bgiframe',
'mxui/layout/block',
'mxui/layout/fill',
'mxui/layout/modal',
'mxui/layout/resize',
'mxui/layout/resizer',
'mxui/layout/sortable',
'mxui/layout/split',
'mxui/layout/table_fill',
'mxui/layout/table_scroll',
'mxui/layout/wrap',
'mxui/nav/accordion',
'mxui/nav/menu',
'mxui/nav/menuable',
'mxui/nav/slider',
'mxui/nav/tabs',
'mxui/nav/toolbar',
'mxui/util/selectable')
@@ -7,7 +7,10 @@ steal('jquery/controller',
'jquery/event/resize',
function($){
/**
* @class Mxui.Nav.Accordion
* @parent Mxui
*/
$.Controller("Mxui.Nav.Accordion",{
defaults : {
title : "h3",
@@ -2,6 +2,10 @@ steal('jquery/controller',
'jquery/event/drag/limit',
'jquery/event/drag/step').then(function( $ ) {
/**
* @class Mxui.Nav.Slider
* @parent Mxui
*/
$.Controller("Mxui.Nav.Slider", {
defaults: {
min: 0,
@@ -9,6 +9,8 @@ $.event.special.activate = {
}
/**
* @class Mxui.Util.Selectable
* @parent Mxui
* Provides keyboard and mouse selection and multi selection to a group of items.
* Instead of listening to click and key events, you can add selectable and listen to
* activate and select events.

0 comments on commit 229cd23

Please sign in to comment.