0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

Ox.Element: update documentation

Browse source
This commit is contained in:
rolux 2012-06-02 12:37:19 +02:00
parent 38ba971dab
commit 39c2497bc5
1 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
source/Ox.UI/js/Core/Element.js
View file

@ -381,27 +381,27 @@ Ox.Element = function(options, self) {
}; };
/*@ /*@
options <function> Gets or sets the options of an element object options <f> Gets or sets the options of an element object
# Usage # Usage
() -> <obj> all options () -> <o> All options
(key) -> <any> the value of option[key] (key) -> <*> The value of option[key]
(key, value) -> <obj> this element (key, value) -> <o> This element
Sets options[key] to value and calls update(key, value) Sets options[key] to value and calls update(key, value)
if the key/value pair was added or modified if the key/value pair was added or modified
({key: value, ...}) -> <obj> this element ({key: value, ...}) -> <o> this element
Sets multiple options and calls update(key, value) Sets multiple options and calls update(key, value)
for every key/value pair that was added or modified for every key/value pair that was added or modified
# Arguments # Arguments
key <str> the name of the option key <s> The name of the option
value <val> the value of the option value <*> The value of the option
@*/ @*/
that.options = function() { that.options = function() {
return Ox.getset(self.options, arguments, update, that); return Ox.getset(self.options, arguments, update, that);
}; };
/*@ /*@
removeElement <function> Removes an element object and its event handler removeElement <f> Removes an element object and its event handler
() -> <obj> This element () -> <o> This element
@*/ @*/
that.remove = function(remove) { that.remove = function(remove) {
remove !== false && that.find('.OxElement').each(function() { remove !== false && that.find('.OxElement').each(function() {