Alien::GvaScript::ProtoExtensions - Extensions to prototype.js
Element.hasAnyClass(elem, ["class1", "class2", ...]); Element.getElementsByClassNames(elem, ["class1", "class2", ...]); var stop_condition = function(elem) { return elem.tagName == "SPAN"}; Element.navigateDom(elem, "nextSibling", ["class1", "class2", ...], stop_condition); this.options = Class.checkOptions(defaultOptions, receivedOptions); Element.register(elem, 'input.active', 'mouseover', function(e) { e._target.addClassName('hover'); }); Element.unregister(elem, 'input.active', 'mouseover'); Element.store(elem, key, value); Element.retrieve(elem, key, default);
Some extensions to the basic abstractions supplied by prototype.js.
Will be a part of prototype's core distribution starting version 1.7 as discussed here [https://prototype.lighthouseapp.com/projects/8886/tickets/435-eventdelegate-and-elementmethodsdelegate]
Prototype.getJSON(url, callback)
based on: getJSON function by Juriy Zaytsev http://github.com/kangax/protolicious/tree/master/get_json.js
A method to temporarily load JSON data (ideally hosted on a different domain and accessible via JSONP service) and send it over to callback method when ready.
var tree = Hash.expand(flat_hash);
Transforms a flat structure of key-value pairs into a nested tree structure, by splitting keys on dots. The idea and algorithm come from CGI::Expand/expand_hash.
Hash.expand({a: '...', b.0.x: '...', b.0.y: '...', b.1.x: '...', b.1.y: '...'}) => {a: '...', b: [{x: '...', y: '...'}, {x: '...', y: '...'}]}
The exact opposite of Hash.expand
Transforms a nested tree structure into a flat hash of key-value pairs where nested keys are joined by a dot.
Strips any trailing line breaks (\r\n) from a String.
only applied to ['SPAN', 'DIV', 'INPUT', 'BUTTON', 'TEXTAREA', 'A'] elements.
used to set a classname to the element for a brief moment of time.
Element.flash(elem, {duration: I<time_mes>, classname: I<classname_to_set>});
if (Element.hasAnyClass(elem, ["class1", "class2", ...]) {...} if (Element.hasAnyClass(elem, "class1") {...}
Returns true if the supplied element has any of the given classes. For convenience, also accepts a single string instead of an array when testing for a single class.
var subElements = Element.getElementsByClassNames(rootElement, ["class1", "class2", ...]);
Returns an array of children of rootElement
that have any
of the given class names.
Element.autoScroll(elem, percentage)
Makes sure that elem
is visible in the central area of
its offset parent; if not, the parent is scrolled.
percentage
is the ratio between the parent height and the
margin at which scrolling must occur, i.e. if
percentage = 20
(the default), then scrolling
occurs if the element is in the higher than the top 20% or
lower than the bottom 20% of the viewport.
Element.outerHTML(elem)
Returns a string representation of the DOM element,
including tags and attributes. Implemented through
the native outerHTML
property, if present; otherwise
constructs a string from tag name, attributes and
innerHTML property.
Form.Element.setValue method is wrapped to fire a 'value:change' custom event with oldvalue and newvalue properties set in the event.memo
Event.detailedStop(event, toStop);
Browser-independent method to control fine details of
event stopping within event handlers.
The toStop
argument is an object
which may contain the following properties:
Just a convenience object, having both properties above set to true. So
Event.detailedStop(event, Event.stopAll);
is equivalent to calling prototype's Event.stop(event)
.
this.options = Class.checkOptions(defaultOptions, ctorOptions)
Utility for constructor methods. The first argument is an object containing a collection of default options (keys and values). The second argument is a similar object, containing options given to the constructor.
If one of the keys in ctorOptions
has no corresponding
key in defaultOptions
, an error is generated (because
the constructor does not expect such a key). Otherwise,
the concatenation of both objects is returned (i.e. values
in ctorOptions
take precedence over values in
defaultOptions
).
ASSERT (cond, msg);
Checks if cond
is true, and if not, generates an error
with message msg
.
CSSPREFIX ();
Returns value of CSS_PREFIX
global variable if found. If not,
default to 'gva'.
This value is used to prefix css classnames of html elements that are derived in some GvaScript classes.