Element object

Executes body of the loop for all child nodes of the element. Value of node variable is either text or element object.

Example, for p element in html:
<p>Hello <em>wonderfull</em> world</p>
loop will be executed three times and node variable will be equal to: "Hello ", Element("em") and " world" on correspondent iteration.

Constructs new Element object with tag equal to tagname (string). Use it as

  var el = new Element("option");

Element will be created in disconnected state. To connect it to the DOM use insert method of the parent element.

Returns string - html representation of the element. Text returned is outer html - includes head and tail tags and content s equal to text returned by  html attribute.

Returns new copy of the element. Method performs a deep copy of the element. New element is disconnected from the DOM state. Use insert() method to include it in the DOM.

Returns first element satisfying CSS selector (CSSselector, string). CSSSelector may contain format specifiers like %d, %s which will be substituted by values of argument1 ... argumentN in final CSS selector string. Function uses the same rules as does Stream.printf function.

Example, if document contains <input type="text"/> element then following statement
var inp = document.select("input[type='text']");
will set inp by reference to such element.

Calls func (function reference) for each element satisfying (matching) CSSselector. Function func shall accept one parameter where select will provide reference to matched element. Function may return true to stop enumeration.

Example, following fragment will print out names of all input elements in the document:
function printel(el) {  stdout.println( el.attributes["name"] );  }
document.select(printel, "input");

Returns first element in child/parent chain satisfying CSS selector (CSSselector, string). CSSSelector may contain format specifiers like %d, %s which will be substituted by values of argument1 ... argumentN in final CSS selector string. Function uses the same rules as does Stream.printf function.

ATTN: Function also inspects this element.

Calls func (function reference) for each element satisfying (matching) CSSselector. Function func shall accept one parameter where select will provide reference to matched element. Function may return true to stop enumeration.

Example, following fragment will print out ids of all parent divs of some element:
function printel(el) {  stdout.println( el.attributes["id"] );  }
some.selectParent(printel, "div");

ATTN: Function also inspects this element.

Checks if this DOM element satisfies given CSSselector.

Returns reference to child element of the given element at x,y coordinates relative to the origin of the element. If there is no such element method returns element itself.

Remeasures given element (if deep == true) and invalidates its visual area after modifications. Use deep=true value if element will get new dimensions due to some operations on it. Omit deep parameter (or set it to false) if only decoration attributes (not changing dimensions, like color) were changed.

Invalidates area of occupied by the element on the screen. If x , y, width, height (coordinates of area inside element) are provided then it invalidates only that portion. This method is useful if you are using Graphics for rendering on element surface area.

Starts animation on the element. nextStep is a function that executes animation step (changes dimension, opacity, etc.). This function is called with this set to the element itself and should return integer - number of milliseconds for the next step. If it returns zero or not an integer then animation stops.

Returns coordinates of the edges of the element. Parameters:

• part - one of symbolic constants #left, #top, #right, #bottom, #width or #height. Defines part of box (rectangle) to return.
• edge, one of edges of element:
• #margin - margin box edge,
• #border - border box edge,
• #padding - padding box edge,
• #inner, default value - inner box edge,
• #content - content box edge. Content box here is outline of the content of the element and this is not  an inner box of the element. E.g. content box can be bigger than inner box if the element has overflow attribute set.
• relativeTo, one of:
• #screen - returns coordinate relative to the origin of the screen,
• #root - returns coordinate relative to the origin of root element (view),
• #parent - returns coordinate of the element in its layout container.
• #self, default value - all coordinates are relative to the origin of inner box of the element.

(part) returns: integer, device pixels

Returns various scrolling related positions of the element. Parameters:

part - one of symbolic constants:

• #left - left position of the view relative to content origin,
• #top - top position,
• #right - offset of right edge of the view from right edge of  the content box,
• #bottom - offset of bottom edge of the view from bottom edge of the content box,
• #width - width of scrollable area,
• #height - height of scrollable area.

Scrolls the element to the view - makes element visible.  If toTop is true then forces element to be on top of its scrollable container.

element is a child DOM element (instance of this Element class) to be inserted at the index position. If index is greater than current number of children in this element then new element will be appended as a last element. Index is optional parameter, if ommited then element will be appended to collection. If element is already a child of some other parent then it will be disconnected from it automaticly.

If first parameter is string (html text) then attempt will be made to insert it at given position.

Removes this element from its parent's children collection so after call of this method this.parent become null. If update is true then calls update() for the parent element. Returns element that was just detached (this).

Loads content of the document referred by url as a content of this element. For elements having behavior:frame assigned it loads html, styles and executes scripts refered by the url or contained in the stream. For any other elements it loads only content of body portion of the document, no style loading or script execution happens in this case.

Loads content of the document from in-memory stream as a content of this element. For elements having behavior:frame assigned it loads html, styles and executes scripts refered by the url or contained in the stream. For any other elements it loads only content of body portion of the document, no style loading or script execution happens in this case.

Loads image from the url. If callback is ommited then the engine will try to load image sycnhronously otherwise (if callback is a function) engine will issue asynchronous request and will call this function upon arrival.

Signature of the callback function is function callback(image) where image is an object of class Image or null in case of error.

Sends synchronous and asynchronous http data GET/POST request to the server/page (url), a.k.a. JSON-RPC calls.

• #get, #post, #json are literal symbols - type of http request to be sent. In case of #json engine will send JSON-RPC request. See JSON-RPC Specification.  
• url is a string - url of the page (location) on the server handling HTTP requests.
• params is an object, its properties are serving role of parameters of HTTP request.
• request returns: 0 if request was handled inside the call (e.g. url is a local file or resource) or some other value if request was placed into execution queue and its result will be delivered later.

  function dataArrivedCallback( data: any );

where data is either one of:

• instanceof Error object, in case of data response parsing problems;
• stream, if data returned by the server is of textual type (text/plain, text/html, text/xml, etc.)
• instanceof Object, Array, etc. if response has content type text/javascript, text/ecmascript, text/tiscript or application/json and was successfully parsed into data object.
• Bytes, if data returned by the server is of binary type (image/*, etc.). Bytes.type in this case will contain a string - mime-type of the data reported by the server.

Example of server data response (type: text/javascript) :

  ({ id : 1234, message : "Hello from XYS server!" })

- in this case server returns object having two properties: id and message. Rationale behind of ({ and }) was explained here.

Returns state of the element. stateFlags here is a set of bits - "ORed" constants STATE_***. stateFlags is provided then function returns int - flags of the element ANDed with the provided stateFlags variable. If no stateFlags is given then the function returns full set of flags element has at hte moment.

Function will set flags to the element update document on the screen accordingly (resolve styles and refresh).

Function will clear flags of the element and update document on the screen.

element.capture(true) - sets the mouse capture to the element and element.capture(false) - removes the mouse capture from the element.

Function will show element el as a popup window placed relatively to this element. Placement accepts following values:

2 - popup element below this element (anchor);

8 - popup element above this element;

4 - popup element on the left side of this element;

6 - popup element on right side of this element;

If milliseconds is greater than zero the method will create timer for the DOM element with milliseconds delay.

After milliseconds delay engine will call callback function with this variable set to the dom element. Return true from the callback() function if you need to continue timer ticks and false otherwise.

Call of timer() with milliseconds = 0 parameter will stop the timer.

Returns Graphics object of the element. Graphics is a bitmap that has dimensions of the element therefore, once drawn, image will stay on the screen. Each invocation of the graphics method with color value will return that bitmap with all bits initialized with the color. To get graphics with current bitmap use graphics() method without any parameters.

To remove graphics from the element use el.graphics(#destroy) call.

traverse (send) bubbling event to the parent/child chain of this element. Events generated by this method can be handled by onControlEvent() methods of elements in the chain.

• eventCode is either one of constants from Logical event codes from builtin behaviors ( see: Event ) or any integer value above 0x1000 (custom control events range).
• reason here is an arbitrary integer value that sender and receiver knows about.
• owner is an optional reference to some DOM element. E.g. in MENU_ITEM_CLICK this is a reference to element - owner of popup menu.

The postEvent places event into the internal queue of posted events for future traversal by sendEvent.

This method allows to delay execution of callback function. While calling the callback function engine will set this environment variable to the element this post call was invoked with.

Optional parameter only_if_not_there if defined and is true allows to post delayed event only once. Multiple post with the same callback function will yield to a single entry in posted events queue.

Method builds absolute url from the relativeUrl by using document url as a base.  If there is no relativeUrl then the method just returns url of the document this DOM element belongs to.

Sorts children of the element by using comparator function. comparator function has to have following signature:

function cmp(el1: Element, el2: Element) : int

that returns negative int value if el1 is less than el2, 0 if they are equal and positive value if el1 is greater than el2.