Librocket API Element

Librocket API references
Elements
Documents
Contexts
Events
API Reference

The LUA interface for libRocket elements closely resembles Gecko’s HTML DOM element interface.

Properties

libRocket property	Brief description	Equivalent DOM property
attributes	All attributes associated with an element.	attributes
child_nodes	All child nodes of an element.	childNodes
class_name	Gets/sets the class of the element.	className
client_height	The inner height of an element.	clientHeight
client_left	The width of the left border of an element.	clientLeft
client_top	The width of the top border of an element.	clientTop
client_width	The inner width of an element.	clientWidth
first_child	The first direct child node of an element.	firstChild
id	Gets/sets the id of the element.	id
inner_rml	Gets/sets the markup and content of the element.	innerHTML
last_child	The last direct child node of an element.	lastChild
next_sibling	The node immediately following the given one in the tree.	nextSibling
offset_height	The height of an element, relative to the layout.	offsetHeight
offset_left	The distance from this element’s left border to its offset parent’s left border.	offsetLeft
offset_parent	The element from which all offset calculations are currently computed.	offsetParent
offset_top	The distance from this element’s top border to its offset parent’s top border.	offsetTop
offset_width	The width of an element, relative to the layout.	offsetWidth
owner_document	The document that this node is in.	ownerDocument
parent_node	The parent element of this node.	parentNode
previous_sibling	The node immediately preceding the given one in the tree.	previousSibling
scroll_height	The scroll view height of an element.	scrollHeight
scroll_left	Gets/sets the left scroll offset of an element.	scrollLeft
scroll_top	Gets/sets the top scroll offset of an element.	scrollTop
scroll_width	The scroll view width of an element.	scrollWidth
style	An object representing the declarations of an element’s style attributes.	style
tag_name	The name of the tag for the given element.	tagName

Array properties

The child_nodes and attributes properties are accessed as arrays; they are indexed numerically, from the front or back, and their length can be queried with the len() function.

child_nodes is an array of element types. The array only includes visible elements; Lua has no way of querying hidden elements. The following example iterates over all of an element’s children, printing their tag names, ids and classes:

for child in element.child_nodes:
	address = child.tag_name

	if child.id != "":
		address += "#" + child.id

	classes = child.class_name.split()
		for class in classes:
			address += "." + class

	ba.print(address)

attributes is an array of attribute types, each of which has a name and value property. The following example iterates over an element’s attributes, printing their names and values:

for attribute in element.attributes:
	ba.print(attribute.name .. ": " .. attribute.value)

The style property

The style property operates identically to its counterpart in Javascript. Properties are accessed as members of the style property by name and can be read or written to. The value of a property is always an unparsed string in this context; ie, 200px, center, rgb(255,0,0), etc.

The following example demonstrates uses of the style property:

element.style.width = "150px"
if element.style.float ~= "none"
	element.style.clear = "left"

Methods

libRocket methods	Brief description	Equivalent DOM method
AddEventListener()	Register an event handler to a specific event type on the element.	addEventListener()
AppendChild()	Insert a node as the last child node of this element.	appendChild()
Blur()	Removes keyboard focus from the current element.	blur()
Click()	Simulates a click on the current element.	click()
DispatchEvent()	Dispatch an event to this node in the DOM.	dispatchEvent()
Focus()	Gives keyboard focus to the current element.	focus()
GetAttribute()	Retrieve the value of the named attribute from the current node.	getAttribute()
GetElementById()	Returns an object reference to the identified element.	getElementById()
GetElementsByTagName()	Retrieve a set of all descendant elements, of a particular tag name, from the current element.	getElementsByTagName()
HasAttribute()	Check if the element has the specified attribute, or not.	hasAttribute()
HasChildNodes()	Check if the element has any child nodes, or not.	hasChildNodes()
InsertBefore()	Inserts the first node before the second, child, node in the DOM.	insertBefore()
RemoveAttribute()	Remove the named attribute from the current node.	removeAttribute()
RemoveChild()	Removes a child node from the current element.	removeChild()
ReplaceChild()	Replaces one child node in the current element with another.	replaceChild()
ScrollIntoView()	Scrolls the page until the element gets into the view.	scrollIntoView()
SetAttribute()	Set the value of the named attribute from the current node.	setAttribute()

Dispatching events

Events can be generated on an element from within Luawith the DispatchEvent() function. When calling this function, the parameters are given as a Lua dictionary.

element:DispatchEvent("open", {"object": "trapdoor", "priority": 11}, False)

Parameter keys must be strings, and values must be strings, integers or floating-point. Others will generate a KeyError or ValueError exception as appropriate.

Creating elements

Elements can be created dynamically in Lua using the document’s CreateElement() or CreateTextNode() method. The following code sample uses CreateElement() to dynamically create a form control.

input_element = document:CreateElement("input")
input_element:SetAttribute("type", "radio")
input_element:SetAttribute("name", "graphics")
input_element:SetAttribute("value", "ok")
document:AppendChild(input_element)

text_element = document.CreateTextNode("OK")
document.AppendChild(text_element)