<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" >
<head><meta content="text/html;charset=&quot;utf-8&quot;" http-equiv="Content-type"/><link href="faldoc.css" rel="stylesheet" type="text/css"/><title> - Class Array</title></head><body class="faldoc"><ul class="navi_top"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="core_bom_classes.html">Up: Basic Object Model</a></li>
<li class="prev"><a href="core_bom_classes.html">Previous: Basic Object Model</a></li>
<li class="next"><a href="core_BOM.html">Next: Class BOM</a></li>
<li class="clear"></li>
</ul><div id="page_body"><h1><span class="toc_number">1.2.1</span>Class Array</h1><p class="brief">MetaClass for Falcon arrays. </p>
<pre class="prototype">Class Array from \
<a href="core_BOM.html">BOM</a>( )</pre>
<p>This is the class reflecting the base array classes. </p>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods</td></tr>
<tr><td><a href="#properties">properties</a></td><td>Returns an array of properties (bindings) in the array. </td></tr>
<tr><td><a href="#setProperty">setProperty</a></td><td>Sets a binding (as a property) in the array. </td></tr>
</tbody>
</table>
<table class="members">
<tbody><tr class="member_type"><td class="member_type" colspan="2">Methods inherited from class <a href="core_BOM.html">BOM</a></td></tr>
<tr><td><a href="core_BOM.html#__add">__add</a></td><td>Overrides binary addition operand. </td></tr>
<tr><td><a href="core_BOM.html#__call">__call</a></td><td>Overrides call operator "self()". </td></tr>
<tr><td><a href="core_BOM.html#__dec">__dec</a></td><td>Overrides decrement unary prefix operand. </td></tr>
<tr><td><a href="core_BOM.html#__decpost">__decpost</a></td><td>Overrides decrement unary postfix operand. </td></tr>
<tr><td><a href="core_BOM.html#__div">__div</a></td><td>Overrides binary division operand. </td></tr>
<tr><td><a href="core_BOM.html#__getIndex">__getIndex</a></td><td>Overrides array access operator [] </td></tr>
<tr><td><a href="core_BOM.html#__inc">__inc</a></td><td>Overrides increment unary prefix operand. </td></tr>
<tr><td><a href="core_BOM.html#__incpost">__incpost</a></td><td>Overrides increment unary postifx operand. </td></tr>
<tr><td><a href="core_BOM.html#__mod">__mod</a></td><td>Overrides modulo operand. </td></tr>
<tr><td><a href="core_BOM.html#__mul">__mul</a></td><td>Overrides binary multiplication operand. </td></tr>
<tr><td><a href="core_BOM.html#__pow">__pow</a></td><td>Overrides power operand. </td></tr>
<tr><td><a href="core_BOM.html#__setIndex">__setIndex</a></td><td>Overrides array write operator [] </td></tr>
<tr><td><a href="core_BOM.html#__sub">__sub</a></td><td>Overrides binary subtraction operand. </td></tr>
<tr><td><a href="core_BOM.html#baseClass">baseClass</a></td><td>Returns the class item from which an object has been instantiated. </td></tr>
<tr><td><a href="core_BOM.html#bound">bound</a></td><td>Determines if an item is bound or not. </td></tr>
<tr><td><a href="core_BOM.html#className">className</a></td><td>Returns the name of the class an instance is instantiated from. </td></tr>
<tr><td><a href="core_BOM.html#clone">clone</a></td><td>Performs a deep copy of the item. </td></tr>
<tr><td><a href="core_BOM.html#compare">compare</a></td><td>Performs a lexicographical comparison. </td></tr>
<tr><td><a href="core_BOM.html#derivedFrom">derivedFrom</a></td><td>Checks if this item has a given parent. </td></tr>
<tr><td><a href="core_BOM.html#describe">describe</a></td><td>Returns the deep contents of an item on a string representation. </td></tr>
<tr><td><a href="core_BOM.html#isCallable">isCallable</a></td><td>Determines if an item is callable. </td></tr>
<tr><td><a href="core_BOM.html#len">len</a></td><td>Retrieves the length of a collection </td></tr>
<tr><td><a href="core_BOM.html#metaclass">metaclass</a></td><td>Returns the metaclass associated with this item. </td></tr>
<tr><td><a href="core_BOM.html#ptr">ptr</a></td><td>Returns a raw memory pointer out of this data (as an integer). </td></tr>
<tr><td><a href="core_BOM.html#serialize">serialize</a></td><td>Serialize the item on a stream for persistent storage. </td></tr>
<tr><td><a href="core_BOM.html#toString">toString</a></td><td>Coverts the object to string. </td></tr>
<tr><td><a href="core_BOM.html#typeId">typeId</a></td><td>Returns an integer indicating the type of this item. </td></tr>
</tbody>
</table>
<h2>Methods</h2><h3><a name="properties">properties</a></h3><p class="brief">Returns an array of properties (bindings) in the array. </p>
<pre class="prototype">Array.properties()</pre>
<table class="prototype">
<tbody><tr class="return"><td class="name">Return</td><td class="content">An array with 0 or more strings. </td></tr>
</tbody>
</table>
<p>This methods returns all the properties in the given array, which represents the list of array bindings. If the array has no bindings, this method returns an empty array. </p>
<p>The property list includes properties that refer to any kind of data, including functions (that is, methods), but it doesn't include properties in the metaclass of this item (FBOM properties). </p>
<p>The returned list is ordered by UNICODE value of the property names. </p>
<h3><a name="setProperty">setProperty</a></h3><p class="brief">Sets a binding (as a property) in the array. </p>
<pre class="prototype">Array.setProperty( propName, value )</pre>
<table class="prototype">
<tbody><tr class="param"><td class="name">propName</td><td class="content"> A string representing the name of a property or a method inside the array. </td></tr>
<tr class="param"><td class="name">value</td><td class="content"> The property new value. </td></tr>
<tr class="raise"><td class="name">Raise</td><td class="content"><table>
<tbody><tr><td class="name"><a href="core_AccessError.html">AccessError</a></td><td class="content"> If the property can't be found. </td></tr>
</tbody>
</table>
</td></tr>
</tbody>
</table>
<p>Alters the value of the property in the given array. If the required property is not present, an AccessError is raised. </p>
</div><ul class="navi_bottom"><li class="top"><a href="index.html">Top: Table of contents</a></li>
<li class="up"><a href="core_bom_classes.html">Up: Basic Object Model</a></li>
<li class="prev"><a href="core_bom_classes.html">Previous: Basic Object Model</a></li>
<li class="next"><a href="core_BOM.html">Next: Class BOM</a></li>
<li class="clear"></li>
</ul><div class="signature">Made with <a href="faldoc 3.0">http://www.falconpl.org</a></div></body></html>
