<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: WireIt WireIt.Container (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://neyric.github.com/wireit" title="WireItLibrary">WireItLibrary</a></h1>
<h3>WireIt <span class="subtitle">0.6.0</span></h3>
<a href="./index.html" title="WireItLibrary">WireItLibrary</a>
> <a href="./module_wireit.html" title="WireIt">WireIt</a>
> WireIt.Container
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">WireIt.Container</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<dl class="subclasses" rel="yui:subclasses">
<dt>Known Subclasses:</dt>
<dd>
<span rel="yui:subclass" resource="WireIt.util.InOutContainer.html">
<a href="WireIt.util.InOutContainer.html" property="yui:name" title="WireIt.util.InOutContainer">WireIt.util.InOutContainer</a>
</span>
<span rel="yui:subclass" resource="WireIt.util.EllipseLabelContainer.html">
<a href="WireIt.util.EllipseLabelContainer.html" property="yui:name" title="WireIt.util.EllipseLabelContainer">WireIt.util.EllipseLabelContainer</a>
</span>
<span rel="yui:subclass" resource="WireIt.util.ImageContainer.html">
<a href="WireIt.util.ImageContainer.html" property="yui:name" title="WireIt.util.ImageContainer">WireIt.util.ImageContainer</a>
</span>
<span rel="yui:subclass" resource="WireIt.FormContainer.html">
<a href="WireIt.FormContainer.html" property="yui:name" title="WireIt.FormContainer">WireIt.FormContainer</a>
</span>
<span rel="yui:subclass" resource="WireIt.CanvasContainer.html">
<a href="WireIt.CanvasContainer.html" property="yui:name" title="WireIt.CanvasContainer">WireIt.CanvasContainer</a>
</span>
<span rel="yui:subclass" resource="inputEx.LayerContainer.html">
<a href="inputEx.LayerContainer.html" property="yui:name" title="inputEx.LayerContainer">inputEx.LayerContainer</a>
</span>
<span rel="yui:subclass" resource="WireIt.RectLabelContainer.html">
<a href="WireIt.RectLabelContainer.html" property="yui:name" title="WireIt.RectLabelContainer">WireIt.RectLabelContainer</a>
</span>
</dd>
</dl>
<div class="summary description" property="yui:description">
Visual module that contains terminals. The wires are updated when the module is dragged around.
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">WireIt.Container</strong>
<code>
(
options
,
layer
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">options</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> Configuration object (see options property)</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">layer</span>
<<span property="yui:type">WireIt.Layer</span>>
</code>
<span property="yui:description"> The WireIt.Layer (or subclass) instance that contains this container</span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="" rel="yui:property" resource="#property_bodyEl">
<h4><a name="property_bodyEl" property="yui:name">bodyEl</a>
- <code><span property="yui:type">{HTMLElement}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Body element
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_className">
<h4><a name="property_className" property="yui:name">className</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
CSS class name for the container element
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: "WireIt-Container"
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_close">
<h4><a name="property_close" property="yui:name">close</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
display a button to close the container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_closeButtonClassName">
<h4><a name="property_closeButtonClassName" property="yui:name">closeButtonClassName</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
CSS class name for the close button
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: "WireIt-Container-closebutton"
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_ddHandle">
<h4><a name="property_ddHandle" property="yui:name">ddHandle</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
(only if draggable) boolean indicating we use a handle for drag'n drop
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_ddHandleClassName">
<h4><a name="property_ddHandleClassName" property="yui:name">ddHandleClassName</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
CSS class name for the drag'n drop handle
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: "WireIt-Container-ddhandle"
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_draggable">
<h4><a name="property_draggable" property="yui:name">draggable</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
boolean that enables drag'n drop on this container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_el">
<h4><a name="property_el" property="yui:name">el</a>
- <code><span property="yui:type">{HTMLElement}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Container DOM element
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_groupable">
<h4><a name="property_groupable" property="yui:name">groupable</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
option to add the grouping button
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_height">
<h4><a name="property_height" property="yui:name">height</a>
- <code><span property="yui:type">Integer</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
initial height of the container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: null
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_icon">
<h4><a name="property_icon" property="yui:name">icon</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
image url to be displayed in the module header
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: null
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_layer">
<h4><a name="property_layer" property="yui:name">layer</a>
- <code><span property="yui:type">{WireIt.Layer}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
the WireIt.Layer object that schould contain this container
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_position">
<h4><a name="property_position" property="yui:name">position</a>
- <code><span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
initial position of the container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: [100,100]
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_preventSelfWiring">
<h4><a name="property_preventSelfWiring" property="yui:name">preventSelfWiring</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
option to prevent connections between terminals of this same container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_resizable">
<h4><a name="property_resizable" property="yui:name">resizable</a>
- <code><span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
boolean that makes the container resizable
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_resizeHandleClassName">
<h4><a name="property_resizeHandleClassName" property="yui:name">resizeHandleClassName</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
CSS class name for the resize handle
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: "WireIt-Container-resizehandle"
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_terminals">
<h4><a name="property_terminals" property="yui:name">terminals</a>
- <code><span property="yui:type">{Array}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
List of the terminals
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_title">
<h4><a name="property_title" property="yui:name">title</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
text that will appear in the module header
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: null
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_width">
<h4><a name="property_width" property="yui:name">width</a>
- <code><span property="yui:type">Integer</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
initial width of the container
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: null
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_wires">
<h4><a name="property_wires" property="yui:name">wires</a>
- <code><span property="yui:type">{Array}</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
List of all the wires connected to this container terminals
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_xtype">
<h4><a name="property_xtype" property="yui:name">xtype</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String representing this class for exporting as JSON
</div>
</div>
<div class="default" property="yui:defaultValue">
Default Value: "WireIt.Container"
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="" rel="yui:method" resource="#method_addTerminal">
<h4>
<a name="method_addTerminal">addTerminal</a></h4>
<div class="detail" >
<code>
WireIt.Terminal
<strong property="yui:name">addTerminal</strong>
(
)
</code>
<div class="description" property="yui:description">
Instanciate the terminal from the class pointer "xtype" (default WireIt.Terminal)
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
WireIt.Terminal
</code></dt>
<dd property="yui:returnInfo">terminal Created terminal</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_dehighlight">
<h4>
<a name="method_dehighlight">dehighlight</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">dehighlight</strong>
(
)
</code>
<div class="description" property="yui:description">
TODO
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getConfig">
<h4>
<a name="method_getConfig">getConfig</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">getConfig</strong>
(
)
</code>
<div class="description" property="yui:description">
Return the config of this container.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getTerminal">
<h4>
<a name="method_getTerminal">getTerminal</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">getTerminal</strong>
(
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getValue">
<h4>
<a name="method_getValue">getValue</a></h4>
<div class="detail" >
<code>
Object
<strong property="yui:name">getValue</strong>
(
)
</code>
<div class="description" property="yui:description">
Subclasses should override this method.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Object
</code></dt>
<dd property="yui:returnInfo">value</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getXY">
<h4>
<a name="method_getXY">getXY</a></h4>
<div class="detail" >
<code>
<strong property="yui:name">getXY</strong>
(
)
</code>
<div class="description" property="yui:description">
Get the position relative to the layer (if any)
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">Array position</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_highlight">
<h4>
<a name="method_highlight">highlight</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">highlight</strong>
(
)
</code>
<div class="description" property="yui:description">
TODO
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_initTerminals">
<h4>
<a name="method_initTerminals">initTerminals</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">initTerminals</strong>
(
)
</code>
<div class="description" property="yui:description">
Call the addTerminal method for each terminal configuration.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_makeDraggable">
<h4>
<a name="method_makeDraggable">makeDraggable</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">makeDraggable</strong>
(
)
</code>
<div class="description" property="yui:description">
Use the DD utility to make container draggable while redrawing the connected wires
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_makeResizable">
<h4>
<a name="method_makeResizable">makeResizable</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">makeResizable</strong>
(
)
</code>
<div class="description" property="yui:description">
Use the DDResize utility to make container resizable while redrawing the connected wires
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onAddWire">
<h4>
<a name="method_onAddWire">onAddWire</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onAddWire</strong>
(
event
,
args
)
</code>
<div class="description" property="yui:description">
This method is called when a wire is added to one of the terminals
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
<<span property="yui:type">Event</span>>
</code>
<span property="yui:description"> The eventAddWire event fired by the terminal</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">Array</span>>
</code>
<span property="yui:description"> This array contains a single element args[0] which is the added Wire instance</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onCloseButton">
<h4>
<a name="method_onCloseButton">onCloseButton</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onCloseButton</strong>
(
)
</code>
<div class="description" property="yui:description">
Called when the user clicked on the close button
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onMouseDown">
<h4>
<a name="method_onMouseDown">onMouseDown</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onMouseDown</strong>
(
)
</code>
<div class="description" property="yui:description">
Called when the user made a mouse down on the container and sets the focus to this container (only if within a Layer)
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onRemoveWire">
<h4>
<a name="method_onRemoveWire">onRemoveWire</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onRemoveWire</strong>
(
event
,
args
)
</code>
<div class="description" property="yui:description">
This method is called when a wire is removed from one of the terminals
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
<<span property="yui:type">Event</span>>
</code>
<span property="yui:description"> The eventRemoveWire event fired by the terminal</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">args</span>
<<span property="yui:type">Array</span>>
</code>
<span property="yui:description"> This array contains a single element args[0] which is the removed Wire instance</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_onResize">
<h4>
<a name="method_onResize">onResize</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">onResize</strong>
(
)
</code>
<div class="description" property="yui:description">
Function called when the container is being resized.
It sets the size of the body element of the container
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_redrawAllTerminals">
<h4>
<a name="method_redrawAllTerminals">redrawAllTerminals</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">redrawAllTerminals</strong>
(
)
</code>
<div class="description" property="yui:description">
Redraw all the wires connected to the terminals of this container
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_remove">
<h4>
<a name="method_remove">remove</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">remove</strong>
(
)
</code>
<div class="description" property="yui:description">
Remove this container from the dom
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_removeAllTerminals">
<h4>
<a name="method_removeAllTerminals">removeAllTerminals</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">removeAllTerminals</strong>
(
)
</code>
<div class="description" property="yui:description">
Remove all terminals
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_removeFocus">
<h4>
<a name="method_removeFocus">removeFocus</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">removeFocus</strong>
(
)
</code>
<div class="description" property="yui:description">
Remove the class that shows the container as "focused"
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_render">
<h4>
<a name="method_render">render</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">render</strong>
(
)
</code>
<div class="description" property="yui:description">
Render the dom of the container
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_setBody">
<h4>
<a name="method_setBody">setBody</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">setBody</strong>
(
content
)
</code>
<div class="description" property="yui:description">
Sets the content of the body element
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">content</span>
<<span property="yui:type">String or HTMLElement</span>>
</code>
<span property="yui:description"></span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_setFocus">
<h4>
<a name="method_setFocus">setFocus</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">setFocus</strong>
(
)
</code>
<div class="description" property="yui:description">
Adds the class that shows the container as "focused"
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_setOptions">
<h4>
<a name="method_setOptions">setOptions</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">setOptions</strong>
(
)
</code>
<div class="description" property="yui:description">
Set the options by putting them in this (so it overrides the prototype default)
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_setValue">
<h4>
<a name="method_setValue">setValue</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">setValue</strong>
(
val
)
</code>
<div class="description" property="yui:description">
Subclasses should override this method.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">val</span>
<<span property="yui:type">Any</span>>
</code>
<span property="yui:description"> Value</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_superHighlight">
<h4>
<a name="method_superHighlight">superHighlight</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">superHighlight</strong>
(
)
</code>
<div class="description" property="yui:description">
TODO
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_eventAddWire">
<h4>
<a name="event_eventAddWire">eventAddWire</a></h4>
<div class="detail">
<code>
<strong property="yui:name">eventAddWire</strong>
(
)
</code>
<div class="description" property="yui:description">
Event that is fired when a wire is added
You can register this event with myContainer.eventAddWire.subscribe(function(e,params) { var wire=params[0];}, scope);
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_eventBlur">
<h4>
<a name="event_eventBlur">eventBlur</a></h4>
<div class="detail">
<code>
<strong property="yui:name">eventBlur</strong>
(
)
</code>
<div class="description" property="yui:description">
Event that is fired when the container loses focus
You can register this event with myContainer.eventBlur.subscribe(function(e,params) { }, scope);
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_eventFocus">
<h4>
<a name="event_eventFocus">eventFocus</a></h4>
<div class="detail">
<code>
<strong property="yui:name">eventFocus</strong>
(
)
</code>
<div class="description" property="yui:description">
Event that is fired when the container is focused
You can register this event with myContainer.eventFocus.subscribe(function(e,params) { }, scope);
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_eventRemoveWire">
<h4>
<a name="event_eventRemoveWire">eventRemoveWire</a></h4>
<div class="detail">
<code>
<strong property="yui:name">eventRemoveWire</strong>
(
)
</code>
<div class="description" property="yui:description">
Event that is fired when a wire is removed
You can register this event with myContainer.eventRemoveWire.subscribe(function(e,params) { var wire=params[0];}, scope);
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animations-plugin.html" title="animations-plugin">animations-plugin</a></li>
<li class=""><a href="module_composable-plugin.html" title="composable-plugin">composable-plugin</a></li>
<li class=""><a href="module_editor-plugin.html" title="editor-plugin">editor-plugin</a></li>
<li class=""><a href="module_inputex-plugin.html" title="inputex-plugin">inputex-plugin</a></li>
<li class=""><a href="module_layout-plugin.html" title="layout-plugin">layout-plugin</a></li>
<li class="selected"><a href="module_wireit.html" title="WireIt">WireIt</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="WireIt.ArrowWire.html" title="WireIt.ArrowWire">WireIt.ArrowWire</a></li>
<li class=""><a href="WireIt.BezierArrowWire.html" title="WireIt.BezierArrowWire">WireIt.BezierArrowWire</a></li>
<li class=""><a href="WireIt.BezierWire.html" title="WireIt.BezierWire">WireIt.BezierWire</a></li>
<li class=""><a href="WireIt.CanvasContainer.html" title="WireIt.CanvasContainer">WireIt.CanvasContainer</a></li>
<li class=""><a href="WireIt.CanvasElement.html" title="WireIt.CanvasElement">WireIt.CanvasElement</a></li>
<li class="selected"><a href="WireIt.Container.html" title="WireIt.Container">WireIt.Container</a></li>
<li class=""><a href="WireIt.Layer.html" title="WireIt.Layer">WireIt.Layer</a></li>
<li class=""><a href="WireIt.LayerMap.html" title="WireIt.LayerMap">WireIt.LayerMap</a></li>
<li class=""><a href="WireIt.LeftSquareArrow.html" title="WireIt.LeftSquareArrow">WireIt.LeftSquareArrow</a></li>
<li class=""><a href="WireIt.RectLabelContainer.html" title="WireIt.RectLabelContainer">WireIt.RectLabelContainer</a></li>
<li class=""><a href="WireIt.RightSquareArrow.html" title="WireIt.RightSquareArrow">WireIt.RightSquareArrow</a></li>
<li class=""><a href="WireIt.Scissors.html" title="WireIt.Scissors">WireIt.Scissors</a></li>
<li class=""><a href="WireIt.StepWire.html" title="WireIt.StepWire">WireIt.StepWire</a></li>
<li class=""><a href="WireIt.Terminal.html" title="WireIt.Terminal">WireIt.Terminal</a></li>
<li class=""><a href="WireIt.TerminalProxy.html" title="WireIt.TerminalProxy">WireIt.TerminalProxy</a></li>
<li class=""><a href="WireIt.util.DD.html" title="WireIt.util.DD">WireIt.util.DD</a></li>
<li class=""><a href="WireIt.util.DDResize.html" title="WireIt.util.DDResize">WireIt.util.DDResize</a></li>
<li class=""><a href="WireIt.util.EllipseLabelContainer.html" title="WireIt.util.EllipseLabelContainer">WireIt.util.EllipseLabelContainer</a></li>
<li class=""><a href="WireIt.util.ImageContainer.html" title="WireIt.util.ImageContainer">WireIt.util.ImageContainer</a></li>
<li class=""><a href="WireIt.util.InOutContainer.html" title="WireIt.util.InOutContainer">WireIt.util.InOutContainer</a></li>
<li class=""><a href="WireIt.util.TerminalInput.html" title="WireIt.util.TerminalInput">WireIt.util.TerminalInput</a></li>
<li class=""><a href="WireIt.util.TerminalOutput.html" title="WireIt.util.TerminalOutput">WireIt.util.TerminalOutput</a></li>
<li class=""><a href="WireIt.Wire.html" title="WireIt.Wire">WireIt.Wire</a></li>
<li class=""><a href="WireIt.WireIt.html" title="WireIt.WireIt">WireIt.WireIt</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ArrowWire.js.html" title="ArrowWire.js">ArrowWire.js</a></li>
<li class=""><a href="BezierArrowWire.js.html" title="BezierArrowWire.js">BezierArrowWire.js</a></li>
<li class=""><a href="BezierWire.js.html" title="BezierWire.js">BezierWire.js</a></li>
<li class=""><a href="CanvasContainer.js.html" title="CanvasContainer.js">CanvasContainer.js</a></li>
<li class=""><a href="CanvasElement.js.html" title="CanvasElement.js">CanvasElement.js</a></li>
<li class=""><a href="Container.js.html" title="Container.js">Container.js</a></li>
<li class=""><a href="DD.js.html" title="DD.js">DD.js</a></li>
<li class=""><a href="DDResize.js.html" title="DDResize.js">DDResize.js</a></li>
<li class=""><a href="EllipseLabelContainer.js.html" title="EllipseLabelContainer.js">EllipseLabelContainer.js</a></li>
<li class=""><a href="ImageContainer.js.html" title="ImageContainer.js">ImageContainer.js</a></li>
<li class=""><a href="InOutContainer.js.html" title="InOutContainer.js">InOutContainer.js</a></li>
<li class=""><a href="Layer.js.html" title="Layer.js">Layer.js</a></li>
<li class=""><a href="LayerMap.js.html" title="LayerMap.js">LayerMap.js</a></li>
<li class=""><a href="LeftSquareArrowWire.js.html" title="LeftSquareArrowWire.js">LeftSquareArrowWire.js</a></li>
<li class=""><a href="RectLabelContainer.js.html" title="RectLabelContainer.js">RectLabelContainer.js</a></li>
<li class=""><a href="RightSquareArrowWire.js.html" title="RightSquareArrowWire.js">RightSquareArrowWire.js</a></li>
<li class=""><a href="Scissors.js.html" title="Scissors.js">Scissors.js</a></li>
<li class=""><a href="StepWire.js.html" title="StepWire.js">StepWire.js</a></li>
<li class=""><a href="Terminal.js.html" title="Terminal.js">Terminal.js</a></li>
<li class=""><a href="TerminalInput.js.html" title="TerminalInput.js">TerminalInput.js</a></li>
<li class=""><a href="TerminalOutput.js.html" title="TerminalOutput.js">TerminalOutput.js</a></li>
<li class=""><a href="TerminalProxy.js.html" title="TerminalProxy.js">TerminalProxy.js</a></li>
<li class=""><a href="Wire.js.html" title="Wire.js">Wire.js</a></li>
<li class=""><a href="WireIt.js.html" title="WireIt.js">WireIt.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class=""><a href="#property_bodyEl" title="bodyEl">bodyEl</a></li>
<li class=""><a href="#property_className" title="className">className</a></li>
<li class=""><a href="#property_close" title="close">close</a></li>
<li class=""><a href="#property_closeButtonClassName" title="closeButtonClassName">closeButtonClassName</a></li>
<li class=""><a href="#property_ddHandle" title="ddHandle">ddHandle</a></li>
<li class=""><a href="#property_ddHandleClassName" title="ddHandleClassName">ddHandleClassName</a></li>
<li class=""><a href="#property_draggable" title="draggable">draggable</a></li>
<li class=""><a href="#property_el" title="el">el</a></li>
<li class=""><a href="#property_groupable" title="groupable">groupable</a></li>
<li class=""><a href="#property_height" title="height">height</a></li>
<li class=""><a href="#property_icon" title="icon">icon</a></li>
<li class=""><a href="#property_layer" title="layer">layer</a></li>
<li class=""><a href="#property_position" title="position">position</a></li>
<li class=""><a href="#property_preventSelfWiring" title="preventSelfWiring">preventSelfWiring</a></li>
<li class=""><a href="#property_resizable" title="resizable">resizable</a></li>
<li class=""><a href="#property_resizeHandleClassName" title="resizeHandleClassName">resizeHandleClassName</a></li>
<li class=""><a href="#property_terminals" title="terminals">terminals</a></li>
<li class=""><a href="#property_title" title="title">title</a></li>
<li class=""><a href="#property_width" title="width">width</a></li>
<li class=""><a href="#property_wires" title="wires">wires</a></li>
<li class=""><a href="#property_xtype" title="xtype">xtype</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class=""><a href="#method_addTerminal" title="addTerminal">addTerminal</a></li>
<li class=""><a href="#method_dehighlight" title="dehighlight">dehighlight</a></li>
<li class=""><a href="#method_getConfig" title="getConfig">getConfig</a></li>
<li class=""><a href="#method_getTerminal" title="getTerminal">getTerminal</a></li>
<li class=""><a href="#method_getValue" title="getValue">getValue</a></li>
<li class=""><a href="#method_getXY" title="getXY">getXY</a></li>
<li class=""><a href="#method_highlight" title="highlight">highlight</a></li>
<li class=""><a href="#method_initTerminals" title="initTerminals">initTerminals</a></li>
<li class=""><a href="#method_makeDraggable" title="makeDraggable">makeDraggable</a></li>
<li class=""><a href="#method_makeResizable" title="makeResizable">makeResizable</a></li>
<li class=""><a href="#method_onAddWire" title="onAddWire">onAddWire</a></li>
<li class=""><a href="#method_onCloseButton" title="onCloseButton">onCloseButton</a></li>
<li class=""><a href="#method_onMouseDown" title="onMouseDown">onMouseDown</a></li>
<li class=""><a href="#method_onRemoveWire" title="onRemoveWire">onRemoveWire</a></li>
<li class=""><a href="#method_onResize" title="onResize">onResize</a></li>
<li class=""><a href="#method_redrawAllTerminals" title="redrawAllTerminals">redrawAllTerminals</a></li>
<li class=""><a href="#method_remove" title="remove">remove</a></li>
<li class=""><a href="#method_removeAllTerminals" title="removeAllTerminals">removeAllTerminals</a></li>
<li class=""><a href="#method_removeFocus" title="removeFocus">removeFocus</a></li>
<li class=""><a href="#method_render" title="render">render</a></li>
<li class=""><a href="#method_setBody" title="setBody">setBody</a></li>
<li class=""><a href="#method_setFocus" title="setFocus">setFocus</a></li>
<li class=""><a href="#method_setOptions" title="setOptions">setOptions</a></li>
<li class=""><a href="#method_setValue" title="setValue">setValue</a></li>
<li class=""><a href="#method_superHighlight" title="superHighlight">superHighlight</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_eventAddWire" title="eventAddWire">eventAddWire</a></li>
<li class=""><a href="#event_eventBlur" title="eventBlur">eventBlur</a></li>
<li class=""><a href="#event_eventFocus" title="eventFocus">eventFocus</a></li>
<li class=""><a href="#event_eventRemoveWire" title="eventRemoveWire">eventRemoveWire</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2010 Eric Abouaf All rights reserved.
</div>
</div>
<script type="text/javascript">
var ALL_YUI_PROPS = [{"url": "WireIt.Container.html#method_addTerminal", "access": "", "host": "WireIt.Container", "type": "method", "name": "addTerminal"}, {"url": "WireIt.Container.html#property_bodyEl", "access": "", "host": "WireIt.Container", "type": "property", "name": "bodyEl"}, {"url": "WireIt.CanvasContainer.html#property_className", "access": "", "host": "WireIt.CanvasContainer", "type": "property", "name": "className"}, {"url": "WireIt.Container.html#property_className", "access": "", "host": "WireIt.Container", "type": "property", "name": "className"}, {"url": "WireIt.Container.html#property_close", "access": "", "host": "WireIt.Container", "type": "property", "name": "close"}, {"url": "WireIt.Container.html#property_closeButtonClassName", "access": "", "host": "WireIt.Container", "type": "property", "name": "closeButtonClassName"}, {"url": "WireIt.BezierWire.html#property_coeffMulDirection", "access": "", "host": "WireIt.BezierWire", "type": "property", "name": "coeffMulDirection"}, {"url": "WireIt.CanvasContainer.html#property_ddHandle", "access": "", "host": "WireIt.CanvasContainer", "type": "property", "name": "ddHandle"}, {"url": "WireIt.Container.html#property_ddHandle", "access": "", "host": "WireIt.Container", "type": "property", "name": "ddHandle"}, {"url": "WireIt.Container.html#property_ddHandleClassName", "access": "", "host": "WireIt.Container", "type": "property", "name": "ddHandleClassName"}, {"url": "WireIt.Container.html#method_dehighlight", "access": "", "host": "WireIt.Container", "type": "method", "name": "dehighlight"}, {"url": "WireIt.CanvasElement.html#method_destroy", "access": "", "host": "WireIt.CanvasElement", "type": "method", "name": "destroy"}, {"url": "WireIt.Container.html#property_draggable", "access": "", "host": "WireIt.Container", "type": "property", "name": "draggable"}, {"url": "WireIt.ArrowWire.html#method_draw", "access": "", "host": "WireIt.ArrowWire", "type": "method", "name": "draw"}, {"url": "WireIt.BezierArrowWire.html#method_draw", "access": "", "host": "WireIt.BezierArrowWire", "type": "method", "name": "draw"}, {"url": "WireIt.BezierWire.html#method_draw", "access": "", "host": "WireIt.BezierWire", "type": "method", "name": "draw"}, {"url": "WireIt.CanvasContainer.html#method_drawCanvas", "access": "", "host": "WireIt.CanvasContainer", "type": "method", "name": "drawCanvas"}, {"url": "WireIt.Container.html#property_el", "access": "", "host": "WireIt.Container", "type": "property", "name": "el"}, {"url": "WireIt.CanvasElement.html#property_element", "access": "", "host": "WireIt.CanvasElement", "type": "property", "name": "element"}, {"url": "WireIt.Container.html#event_eventAddWire", "access": "", "host": "WireIt.Container", "type": "event", "name": "eventAddWire"}, {"url": "WireIt.Container.html#event_eventBlur", "access": "", "host": "WireIt.Container", "type": "event", "name": "eventBlur"}, {"url": "WireIt.Container.html#event_eventFocus", "access": "", "host": "WireIt.Container", "type": "event", "name": "eventFocus"}, {"url": "WireIt.Container.html#event_eventRemoveWire", "access": "", "host": "WireIt.Container", "type": "event", "name": "eventRemoveWire"}, {"url": "WireIt.Container.html#method_getConfig", "access": "", "host": "WireIt.Container", "type": "method", "name": "getConfig"}, {"url": "WireIt.CanvasElement.html#method_getContext", "access": "", "host": "WireIt.CanvasElement", "type": "method", "name": "getContext"}, {"url": "WireIt.Container.html#method_getTerminal", "access": "", "host": "WireIt.Container", "type": "method", "name": "getTerminal"}, {"url": "WireIt.Container.html#method_getValue", "access": "", "host": "WireIt.Container", "type": "method", "name": "getValue"}, {"url": "WireIt.Container.html#method_getXY", "access": "", "host": "WireIt.Container", "type": "method", "name": "getXY"}, {"url": "WireIt.Container.html#property_groupable", "access": "", "host": "WireIt.Container", "type": "property", "name": "groupable"}, {"url": "WireIt.CanvasContainer.html#property_height", "access": "", "host": "WireIt.CanvasContainer", "type": "property", "name": "height"}, {"url": "WireIt.Container.html#property_height", "access": "", "host": "WireIt.Container", "type": "property", "name": "height"}, {"url": "WireIt.Container.html#method_highlight", "access": "", "host": "WireIt.Container", "type": "method", "name": "highlight"}, {"url": "WireIt.Container.html#property_icon", "access": "", "host": "WireIt.Container", "type": "property", "name": "icon"}, {"url": "WireIt.Container.html#method_initTerminals", "access": "", "host": "WireIt.Container", "type": "method", "name": "initTerminals"}, {"url": "WireIt.Container.html#property_layer", "access": "", "host": "WireIt.Container", "type": "property", "name": "layer"}, {"url": "WireIt.Container.html#method_makeDraggable", "access": "", "host": "WireIt.Container", "type": "method", "name": "makeDraggable"}, {"url": "WireIt.Container.html#method_makeResizable", "access": "", "host": "WireIt.Container", "type": "method", "name": "makeResizable"}, {"url": "WireIt.Container.html#method_onAddWire", "access": "", "host": "WireIt.Container", "type": "method", "name": "onAddWire"}, {"url": "WireIt.Container.html#method_onCloseButton", "access": "", "host": "WireIt.Container", "type": "method", "name": "onCloseButton"}, {"url": "WireIt.Container.html#method_onMouseDown", "access": "", "host": "WireIt.Container", "type": "method", "name": "onMouseDown"}, {"url": "WireIt.Container.html#method_onRemoveWire", "access": "", "host": "WireIt.Container", "type": "method", "name": "onRemoveWire"}, {"url": "WireIt.CanvasContainer.html#method_onResize", "access": "", "host": "WireIt.CanvasContainer", "type": "method", "name": "onResize"}, {"url": "WireIt.Container.html#method_onResize", "access": "", "host": "WireIt.Container", "type": "method", "name": "onResize"}, {"url": "WireIt.Container.html#property_position", "access": "", "host": "WireIt.Container", "type": "property", "name": "position"}, {"url": "WireIt.Container.html#property_preventSelfWiring", "access": "", "host": "WireIt.Container", "type": "property", "name": "preventSelfWiring"}, {"url": "WireIt.Container.html#method_redrawAllTerminals", "access": "", "host": "WireIt.Container", "type": "method", "name": "redrawAllTerminals"}, {"url": "WireIt.Container.html#method_remove", "access": "", "host": "WireIt.Container", "type": "method", "name": "remove"}, {"url": "WireIt.Container.html#method_removeAllTerminals", "access": "", "host": "WireIt.Container", "type": "method", "name": "removeAllTerminals"}, {"url": "WireIt.Container.html#method_removeFocus", "access": "", "host": "WireIt.Container", "type": "method", "name": "removeFocus"}, {"url": "WireIt.CanvasContainer.html#method_render", "access": "", "host": "WireIt.CanvasContainer", "type": "method", "name": "render"}, {"url": "WireIt.Container.html#method_render", "access": "", "host": "WireIt.Container", "type": "method", "name": "render"}, {"url": "WireIt.Container.html#property_resizable", "access": "", "host": "WireIt.Container", "type": "property", "name": "resizable"}, {"url": "WireIt.Container.html#property_resizeHandleClassName", "access": "", "host": "WireIt.Container", "type": "property", "name": "resizeHandleClassName"}, {"url": "WireIt.Container.html#method_setBody", "access": "", "host": "WireIt.Container", "type": "method", "name": "setBody"}, {"url": "WireIt.CanvasElement.html#method_SetCanvasRegion", "access": "", "host": "WireIt.CanvasElement", "type": "method", "name": "SetCanvasRegion"}, {"url": "WireIt.Container.html#method_setFocus", "access": "", "host": "WireIt.Container", "type": "method", "name": "setFocus"}, {"url": "WireIt.Container.html#method_setOptions", "access": "", "host": "WireIt.Container", "type": "method", "name": "setOptions"}, {"url": "WireIt.Container.html#method_setValue", "access": "", "host": "WireIt.Container", "type": "method", "name": "setValue"}, {"url": "WireIt.Container.html#method_superHighlight", "access": "", "host": "WireIt.Container", "type": "method", "name": "superHighlight"}, {"url": "WireIt.Container.html#property_terminals", "access": "", "host": "WireIt.Container", "type": "property", "name": "terminals"}, {"url": "WireIt.Container.html#property_title", "access": "", "host": "WireIt.Container", "type": "property", "name": "title"}, {"url": "WireIt.CanvasContainer.html#property_width", "access": "", "host": "WireIt.CanvasContainer", "type": "property", "name": "width"}, {"url": "WireIt.Container.html#property_width", "access": "", "host": "WireIt.Container", "type": "property", "name": "width"}, {"url": "WireIt.Container.html#property_wires", "access": "", "host": "WireIt.Container", "type": "property", "name": "wires"}, {"url": "WireIt.ArrowWire.html#property_xtype", "access": "", "host": "WireIt.ArrowWire", "type": "property", "name": "xtype"}, {"url": "WireIt.BezierArrowWire.html#property_xtype", "access": "", "host": "WireIt.BezierArrowWire", "type": "property", "name": "xtype"}, {"url": "WireIt.BezierWire.html#property_xtype", "access": "", "host": "WireIt.BezierWire", "type": "property", "name": "xtype"}, {"url": "WireIt.CanvasContainer.html#property_xtype", "access": "", "host": "WireIt.CanvasContainer", "type": "property", "name": "xtype"}, {"url": "WireIt.Container.html#property_xtype", "access": "", "host": "WireIt.Container", "type": "property", "name": "xtype"}];
</script>
</body>
</html>
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #1 | 16445 | christiane_renck | Rename/move file(s) | ||
| //guest/christiane_renck/MergeQuestJS/main/demos/WireIt/api/WireIt.Container.html | |||||
| #1 | 16444 | christiane_renck | Adding MergeQuestJS to the Workshop. | ||