1
0
Fork 0
forked from 0x2620/oxjs

document events

This commit is contained in:
j 2012-06-18 00:38:26 +02:00
commit d2e05200da
56 changed files with 277 additions and 32 deletions

View file

@ -3,6 +3,18 @@
/*@
Ox.ArrayEditable <f> Array Editable
([options[, self]]) -> <o:Ox.Element> Array Editable
add <!> add
blur <!> blur
change <!> change
delete <!> delete
edit <!> edit
insert <!> insert
open <!> open
selectafter <!> selectafter
selectbefore <!> selectbefore
selectnone <!> selectnone
select <!> select
submit <!> submit
options <o> Options object
self <o> Shared private variable
@*/

View file

@ -10,6 +10,7 @@ Ox.ArrayInput <f> Array input
value <[]> value
width <n|256> width
self <o> Shared private variable
change <!> change
@*/
Ox.ArrayInput = function(options, self) {

View file

@ -122,10 +122,16 @@ Ox.ButtonGroup = function(options, self) {
}
}
/*@
disableButton <f> disableButton
@*/
that.disableButton = function(id) {
getButtonById(id).options({disabled: true});
};
/*@
enableButton <f> enableButton
@*/
that.enableButton = function(id) {
getButtonById(id).options({disabled: false});
};

View file

@ -3,6 +3,7 @@
/*@
Ox.Checkbox <f> Checkbox Element
([options[, self]]) -> <o:Ox.Element> Checkbox Element
change <!> triggered when value changes
options <o> Options object
disabled <b> if true, checkbox is disabled
group <b> if true, checkbox is part of a group
@ -12,7 +13,6 @@ Ox.Checkbox <f> Checkbox Element
value <b> if true, checkbox is checked
width <n> width in px
self <o> Shared private variable
change <!> triggered when value changes
@*/
Ox.Checkbox = function(options, self) {

View file

@ -3,6 +3,8 @@
/*@
Ox.CheckboxGroup <f> CheckboxGroup Object
([options[, self]]) -> <o:Ox.Element> CheckboxGroup Object
change <!> triggered when checked property changes
passes {id, title, value}
options <o> Options object
checkboxes <a|[]> array of checkboxes
max <n|1> max selected
@ -10,8 +12,6 @@ Ox.CheckboxGroup <f> CheckboxGroup Object
type <s|"group"> type ("group" or "list")
width <n> width in px
self <o> shared private variable
change <!> triggered when checked property changes
passes {id, title, value}
@*/
Ox.CheckboxGroup = function(options, self) {

View file

@ -3,6 +3,7 @@
/*@
Ox.ColorInput <f> ColorInput Element
([options[, self]]) -> <o:Ox.InputGroup> ColorInput Element
change <!> change
options <o> Options object
mode <s|'rgb'> Mode ('rgb' or 'hsl')
value <[n]|[0, 0, 0]> Value

View file

@ -3,11 +3,11 @@
/*@
Ox.ColorPicker <f> ColorPicker Element
([options[, self]]) -> <o:Ox.Picker> ColorPicker Element
change <!> triggered on change of value
options <o> Options object
mode <s|'rgb'> Mode ('rgb' or 'hsl')
value <[n]|[0, 0, 0]> Value
self <o> Shared private variable
change <!> triggered on change of value
@*/
Ox.ColorPicker = function(options, self) {

View file

@ -3,6 +3,7 @@
/*@
Ox.DateInput <f> DateInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateInput Element
change <!> triggered on change of value
options <o> Options object
format <s|short> format can be short, medium, long
value <d> date value, defaults to current date
@ -13,7 +14,6 @@ Ox.DateInput <f> DateInput Element
weekday <n> width of weekday input element
year <n> width of year input element
self <o> Shared private variable
change <!> triggered on change of value
@*/
Ox.DateInput = function(options, self) {

View file

@ -3,6 +3,7 @@
/*@
Ox.DateTimeInput <f> DateTimeInput Element
([options[, self]]) -> <o:Ox.InputGroup> DateTimeInput Element
change <!> triggered on change of value
options <o> Options object
ampm <b|false> false is 24h true is am/pm
format <s|short> options are short, medium, long
@ -10,7 +11,6 @@ Ox.DateTimeInput <f> DateTimeInput Element
value <d> defautls to now
weekday <b|false> weekday
self <o> Shared private variable
change <!> triggered on change of value
@*/
Ox.DateTimeInput = function(options, self) {

View file

@ -3,6 +3,11 @@
/*@
Ox.Editable <f> Editable element
([options[, self]]) -> <o:Ox.Element> Input Element
blur <!> blur
cancel <!> cancel
edit <!> edit
open <!> open
submit <!> submit
options <o> Options object
editing <b|false> If true, loads in editing state
format <f|null> Format function
@ -257,6 +262,9 @@ Ox.Editable = function(options, self) {
that.triggerEvent('submit', {value: self.options.value});
}
/*@
css <f> css
@*/
that.css = function(css) {
self.css = css;
that.$element.css(css);

View file

@ -3,6 +3,7 @@
/*@
Ox.FileButton <f> File Button
([options[, self]]) -> <o:Ox.Element> File Button
click <!> click
options <o> Options
self <o> Shared private variable
@*/

View file

@ -3,6 +3,7 @@
/*@
Ox.FileInput <f> File Input
([options[, self]]) -> <o:Ox.Element> File Input
change <!> change
options <o> Options
self <o> Shared private variable
@*/

View file

@ -3,6 +3,7 @@
/*@
Ox.Filter <f> Filter Object
([options[, self]]) -> <o:Ox.Element> Filter Object
change <!> change
options <o> Options object
findKeys <[]|[]> keys
list <o> list object

View file

@ -3,6 +3,9 @@
/*@
Ox.Form <f> Form Object
([options[, self]]) -> <o:Ox.Element> Form Object
change <!> change
validate <!> validate
submit <!> submit
options <o> Options object
error <s> error
id <s> id

View file

@ -3,6 +3,9 @@
/*@
Ox.FormElementGroup <f> FormElementGroup Element
([options[, self]]) -> <o:Ox.Element> FormElementGroup Element
autovalidate <!> autovalidate
change <!> change
validate <!> validate
options <o> Options object
id <s> element id
elements <[o:Ox.Element]|[]> elements in group

View file

@ -3,6 +3,8 @@
/*@
Ox.FormPanel <f> Form Panel
([options[, self]]) -> <o:Ox.Element> Form Panel
change <!> change
validate <!> validate
options <o> Options
self <o> Shared private variable
@*/

View file

@ -3,6 +3,16 @@
/*@
Ox.Input <f> Input Element
([options[, self]]) -> <o:Ox.Element> Input Element
autocomplete <!> autocomplete
autovalidate <!> autovalidate
blur <!> blur
cancel <!> cancel
change <!> input changed event
clear <!> clear
focus <!> focus
insert <!> insert
submit <!> input submit event
validate <!> validate
options <o> Options object
arrows <b> if true, and type is 'float' or 'int', display arrows
arrowStep <n> step when clicking arrows
@ -56,8 +66,6 @@ Ox.Input <f> Input Element
validate <f> remote validation
width <n> px
change <!> input changed event
submit <!> input submit event
@*/
Ox.Input = function(options, self) {

View file

@ -3,6 +3,8 @@
/*@
Ox.InputGroup <f> InputGroup Object
([options[, self]]) -> <o:Ox.Element> InputGroup Object
change <!> change
validate <!> validate
options <o> Options object
id <s|''> id
inputs <a|[]> inputs

View file

@ -3,6 +3,7 @@
/*@
Ox.ObjectArrayInput <f> Object Array Input
([options[, self]]) -> <o:Ox.Element> Object Array Input
change <!> change
options <o> Options
buttonTitles
inputs

View file

@ -3,6 +3,7 @@
/*@
Ox.ObjectInput <f> Object Input
([options[, self]]) -> <o:Ox.Element> Object Input
change <!> change
options <o> Options
self <o> Shared private variable
@*/

View file

@ -3,14 +3,14 @@
/*@
Ox.Picker <f> Picker Object
([options[, self]]) -> <o:Ox.Element> Picker Object
show <!> picker is shown
hide <!> picker is hidden
options <o> Options object
element <o|null> picker element
elementHeight <n|128> height
elemementWidth <n|256> width
id <s> picker id
overlap <s|none> select button overlap value
show <!> picker is shown
hide <!> picker is hidden
@*/
Ox.Picker = function(options, self) {

View file

@ -3,6 +3,7 @@
/*@
Ox.Range <f> Range Object
([options[, self]]) -> <o:Ox.Element> Range Object
change <!> triggered on change of the range
options <o> Options object
arrows <b> if true, show arrows
arrowStep <n> step when clicking arrows
@ -22,7 +23,6 @@ Ox.Range <f> Range Object
value <n> initial value
values <[s]> values to display on thumb
self <o> shared private variable
change <!> triggered on change of the range
@*/
Ox.Range = function(options, self) {

View file

@ -3,6 +3,8 @@
/*@
Ox.Select <f> Select Object
([options[, self]) -> <o:Ox.Element> Select Object
click <!> Click event
change <!> Change event
options <o> Options object
disabled <b|false> If true, select is disabled
id <s> Element id
@ -24,8 +26,6 @@ Ox.Select <f> Select Object
value <a|s> Selected id, or array of selected ids
width <s|n|'auto'> Width in px, or 'auto'
self <o> Shared private variable
click <!> Click event
change <!> Change event
@*/
Ox.Select = function(options, self) {

View file

@ -3,6 +3,7 @@
/*@
Ox.Spreadsheet <f> Spreadsheet
([options[, self]]) -> <o:Ox.Element> Spreadsheet
change <!> change
options <o> Options
self <o> Shared private variable
@*/