maxGraph/docs/js-api/files/editor/mxDefaultToolbar-js.html

89 lines
65 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>mxDefaultToolbar</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxDefaultToolbar"></a>mxDefaultToolbar</h1><div class=CBody><p>Toolbar for the editor.&nbsp; This modifies the state of the graph or inserts new cells upon mouse clicks.</p><h4 class=CHeading>Example</h4><p>Create a toolbar with a button to copy the selection into the clipboard, and a combo box with one action to paste the selection from the clipboard into the graph.</p><blockquote><pre class="prettyprint">var toolbar = new mxDefaultToolbar(container, editor);
toolbar.addItem('Copy', null, 'copy');
var combo = toolbar.addActionCombo('More actions...');
toolbar.addActionOption(combo, 'Paste', 'paste');</pre></blockquote><h4 class=CHeading>Codec</h4><p>This class uses the <a href="../io/mxDefaultToolbarCodec-js.html#mxDefaultToolbarCodec" class=LClass id=link36 onMouseOver="ShowTip(event, 'tt26', 'link36')" onMouseOut="HideTip('tt26')">mxDefaultToolbarCodec</a> to read configuration data into an existing instance.&nbsp; See <a href="../io/mxDefaultToolbarCodec-js.html#mxDefaultToolbarCodec" class=LClass id=link37 onMouseOver="ShowTip(event, 'tt26', 'link37')" onMouseOut="HideTip('tt26')">mxDefaultToolbarCodec</a> for a description of the configuration format.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxDefaultToolbar" >mxDefaultToolbar</a></td><td class=SDescription>Toolbar for the editor. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxDefaultToolbar.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbar.mxDefaultToolbar" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxDefaultToolbar</a></td><td class=SDescription>Constructs a new toolbar for the given container and editor. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxDefaultToolbar.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbar.editor" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">editor</a></td><td class=SDescription>Reference to the enclosing <a href="mxEditor-js.html#mxEditor" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxEditor</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxDefaultToolbar.toolbar" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">toolbar</a></td><td class=SDescription>Holds the internal <a href="../util/mxToolbar-js.html#mxToolbar" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">mxToolbar</a>.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbar.resetHandler" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">resetHandler</a></td><td class=SDescription>Reference to the function used to reset the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link7 onMouseOver="ShowTip(event, 'tt4', 'link7')" onMouseOut="HideTip('tt4')">toolbar</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxDefaultToolbar.spacing" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">spacing</a></td><td class=SDescription>Defines the spacing between existing and new vertices in gridSize units when a new vertex is dropped on an existing cell. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbar.connectOnDrop" id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">connectOnDrop</a></td><td class=SDescription>Specifies if elements should be connected if new cells are dropped onto connectable elements. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxDefaultToolbar.init" id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">init</a></td><td class=SDescription>Constructs the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link11 onMouseOver="ShowTip(event, 'tt4', 'link11')" onMouseOut="HideTip('tt4')">toolbar</a> for the given container and installs a listener that updates the <a href="mxEditor-js.html#mxEditor.insertFunction" class=LVariable id=link12 onMouseOver="ShowTip(event, 'tt10', 'link12')" onMouseOut="HideTip('tt10')">mxEditor.insertFunction</a> on <a href="#mxDefaultToolbar.editor" class=LVariable id=link13 onMouseOver="ShowTip(event, 'tt2', 'link13')" onMouseOut="HideTi
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.mxDefaultToolbar"></a>mxDefaultToolbar</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxDefaultToolbar(</td><td class=PParameter nowrap>container,</td></tr><tr><td></td><td class=PParameter nowrap>editor</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new toolbar for the given container and editor.&nbsp; The container and editor may be null if a prototypical instance for a <a href="../io/mxDefaultKeyHandlerCodec-js.html#mxDefaultKeyHandlerCodec" class=LClass id=link38 onMouseOver="ShowTip(event, 'tt27', 'link38')" onMouseOut="HideTip('tt27')">mxDefaultKeyHandlerCodec</a> is created.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>container</td><td class=CDLDescription>DOM node that contains the toolbar.</td></tr><tr><td class=CDLEntry>editor</td><td class=CDLDescription>Reference to the enclosing <a href="mxEditor-js.html#mxEditor" class=LClass id=link39 onMouseOver="ShowTip(event, 'tt3', 'link39')" onMouseOut="HideTip('tt3')">mxEditor</a>.</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.editor"></a>editor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.editor</td></tr></table></blockquote><p>Reference to the enclosing <a href="mxEditor-js.html#mxEditor" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt3', 'link40')" onMouseOut="HideTip('tt3')">mxEditor</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.toolbar"></a>toolbar</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.toolbar</td></tr></table></blockquote><p>Holds the internal <a href="../util/mxToolbar-js.html#mxToolbar" class=LClass id=link41 onMouseOver="ShowTip(event, 'tt5', 'link41')" onMouseOut="HideTip('tt5')">mxToolbar</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.resetHandler"></a>resetHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.resetHandler</td></tr></table></blockquote><p>Reference to the function used to reset the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link42 onMouseOver="ShowTip(event, 'tt4', 'link42')" onMouseOut="HideTip('tt4')">toolbar</a>.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.spacing"></a>spacing</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.spacing</td></tr></table></blockquote><p>Defines the spacing between existing and new vertices in gridSize units when a new vertex is dropped on an existing cell.&nbsp; Default is 4 (40 pixels).</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.connectOnDrop"></a>connectOnDrop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.connectOnDrop</td></tr></table></blockquote><p>Specifies if elements should be connected if new cells are dropped onto connectable elements.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.init"></a>init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.init</td></tr></table></blockquote><p>Constructs the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link43 onMouseOver="ShowTip(event, 'tt4', 'link43')" onMouseOut="HideTip('tt4')">toolbar</a> for the given container and installs a listener that updates the <a href="mxEditor-js.html#mxEditor.insertFunction" class=LVariable id=link44 onMouseOver="ShowTip(event, 'tt10', 'link44')" onMouseOut="HideTip('tt10')">mxEditor.insertFunction</a> on <a href="#mxDefaultToolbar.editor" class=LVariable id=link45 onMouseOver="ShowTip(event, 'tt2', 'link45')" onMouseOut="HideTip('tt2')">editor</a> if an item is selected in the toolbar.&nbsp; This assumes that <a href="#mxDefaultToolbar.editor" class=LVariable id=link46 onMouseOver="ShowTip(event, 'tt2', 'link46')" onMouseOut="HideTip('tt2')">editor</a> is not null.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>container</td><td class=CDLDescription>DOM node that contains the toolbar.</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addItem"></a>addItem</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addItem = function(</td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>icon,</td></tr><tr><td></td><td class=PParameter nowrap>action,</td></tr><tr><td></td><td class=PParameter nowrap>pressed</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a new item that executes the given action in <a href="#mxDefaultToolbar.editor" class=LVariable id=link47 onMouseOver="ShowTip(event, 'tt2', 'link47')" onMouseOut="HideTip('tt2')">editor</a>.&nbsp; The title, icon and pressedIcon are used to display the toolbar item.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title (tooltip) for the item.</td></tr><tr><td class=CDLEntry>icon</td><td class=CDLDescription>URL of the icon to be used for displaying the item.</td></tr><tr><td class=CDLEntry>action</td><td class=CDLDescription>Name of the action to execute when the item is clicked.</td></tr><tr><td class=CDLEntry>pressed</td><td class=CDLDescription>Optional URL of the icon for the pressed state.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addSeparator"></a>addSeparator</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addSeparator = function(</td><td class=PParameter nowrap>icon</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a vertical separator using the optional icon.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>icon</td><td class=CDLDescription>Optional URL of the icon that represents the vertical separator.&nbsp; Default is <a href="../mxClient-js.html#mxClient.imageBasePath" class=LVariable id=link48 onMouseOver="ShowTip(event, 'tt28', 'link48')" onMouseOut="HideTip('tt28')">mxClient.imageBasePath</a> + &lsquo;/separator.gif&rsquo;.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addCombo"></a>addCombo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.addCombo = function()</td></tr></table></blockquote><p>Helper method to invoke <a href="../util/mxToolbar-js.html#mxToolbar.addCombo" class=LFunction id=link49 onMouseOver="ShowTip(event, 'tt14', 'link49')" onMouseOut="HideTip('tt14')">mxToolbar.addCombo</a> on <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link50 onMouseOver="ShowTip(event, 'tt4', 'link50')" onMouseOut="HideTip('tt4')">toolbar</a> and return the resulting DOM node.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addActionCombo"></a>addActionCombo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addActionCombo = function(</td><td class=PParameter nowrap>title</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to invoke &lt;mxToolbar.addActionCombo&gt; on <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link51 onMouseOver="ShowTip(event, 'tt4', 'link51')" onMouseOut="HideTip('tt4')">toolbar</a> using the given title and return the resulting DOM node.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title of the combo.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addActionOption"></a>addActionOption</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addActionOption = function(</td><td class=PParameter nowrap>combo,</td></tr><tr><td></td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>action</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Binds the given action to a option with the specified label in the given combo.&nbsp; Combo is an object returned from an earlier call to <a href="#mxDefaultToolbar.addCombo" class=LFunction id=link52 onMouseOver="ShowTip(event, 'tt13', 'link52')" onMouseOut="HideTip('tt13')">addCombo</a> or <a href="#mxDefaultToolbar.addActionCombo" class=LFunction id=link53 onMouseOver="ShowTip(event, 'tt15', 'link53')" onMouseOut="HideTip('tt15')">addActionCombo</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>combo</td><td class=CDLDescription>DOM node that represents the combo box.</td></tr><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title of the combo.</td></tr><tr><td class=CDLEntry>action</td><td class=CDLDescription>Name of the action to execute in <a href="#mxDefaultToolbar.editor" class=LVariable id=link54 onMouseOver="ShowTip(event, 'tt2', 'link54')" onMouseOut="HideTip('tt2')">editor</a>.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addOption"></a>addOption</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addOption = function(</td><td class=PParameter nowrap>combo,</td></tr><tr><td></td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>value</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to invoke <a href="../util/mxToolbar-js.html#mxToolbar.addOption" class=LFunction id=link55 onMouseOver="ShowTip(event, 'tt18', 'link55')" onMouseOut="HideTip('tt18')">mxToolbar.addOption</a> on <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link56 onMouseOver="ShowTip(event, 'tt4', 'link56')" onMouseOut="HideTip('tt4')">toolbar</a> and return the resulting DOM node that represents the option.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>combo</td><td class=CDLDescription>DOM node that represents the combo box.</td></tr><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title of the combo.</td></tr><tr><td class=CDLEntry>value</td><td class=CDLDescription>Object that represents the value of the option.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addMode"></a>addMode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addMode = function(</td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>icon,</td></tr><tr><td></td><td class=PParameter nowrap>mode,</td></tr><tr><td></td><td class=PParameter nowrap>pressed,</td></tr><tr><td></td><td class=PParameter nowrap>funct</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates an item for selecting the given mode in the <a href="#mxDefaultToolbar.editor" class=LVariable id=link57 onMouseOver="ShowTip(event, 'tt2', 'link57')" onMouseOut="HideTip('tt2')">editor</a>&rsquo;s graph.&nbsp; Supported modenames are select, connect and pan.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title of the item.</td></tr><tr><td class=CDLEntry>icon</td><td class=CDLDescription>URL of the icon that represents the item.</td></tr><tr><td class=CDLEntry>mode</td><td class=CDLDescription>String that represents the mode name to be used in <a href="mxEditor-js.html#mxEditor.setMode" class=LFunction id=link58 onMouseOver="ShowTip(event, 'tt29', 'link58')" onMouseOut="HideTip('tt29')">mxEditor.setMode</a>.</td></tr><tr><td class=CDLEntry>pressed</td><td class=CDLDescription>Optional URL of the icon that represents the pressed state.</td></tr><tr><td class=CDLEntry>funct</td><td class=CDLDescription>Optional JavaScript function that takes the <a href="mxEditor-js.html#mxEditor" class=LClass id=link59 onMouseOver="ShowTip(event, 'tt3', 'link59')" onMouseOut="HideTip('tt3')">mxEditor</a> as the first and only argument that is executed after the mode has been selected.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.addPrototype"></a>addPrototype</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addPrototype = function(</td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>icon,</td></tr><tr><td></td><td class=PParameter nowrap>ptype,</td></tr><tr><td></td><td class=PParameter nowrap>pressed,</td></tr><tr><td></td><td class=PParameter nowrap>insert,</td></tr><tr><td></td><td class=PParameter nowrap>toggle</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates an item for inserting a clone of the specified prototype cell into the <a href="#mxDefaultToolbar.editor" class=LVariable id=link60 onMouseOver="ShowTip(event, 'tt2', 'link60')" onMouseOut="HideTip('tt2')">editor</a>&rsquo;s graph.&nbsp; The ptype may either be a cell or a function that returns a cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>title</td><td class=CDLDescription>String that represents the title of the item.</td></tr><tr><td class=CDLEntry>icon</td><td class=CDLDescription>URL of the icon that represents the item.</td></tr><tr><td class=CDLEntry>ptype</td><td class=CDLDescription>Function or object that represents the prototype cell.&nbsp; If ptype is a function then it is invoked with no arguments to create new instances.</td></tr><tr><td class=CDLEntry>pressed</td><td class=CDLDescription>Optional URL of the icon that represents the pressed state.</td></tr><tr><td class=CDLEntry>insert</td><td class=CDLDescription>Optional JavaScript function that handles an insert of the new cell.&nbsp; This function takes the <a href="mxEditor-js.html#mxEditor" class=LClass id=link61 onMouseOver="ShowTip(event, 'tt3', 'link61')" onMouseOut="HideTip('tt3')">mxEditor</a>, new cell to be inserted, mouse event and optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link62 onMouseOver="ShowTip(event, 'tt30', 'link62')" onMouseOut="HideTip('tt30')">mxCell</a> under the mouse pointer as arguments.</td></tr><tr><td class=CDLEntry>toggle</td><td class=CDLDescription>Optional boolean that specifies if the item can be toggled.&nbsp; Default is true.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.drop"></a>drop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.drop = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles a drop from a toolbar item to the graph.&nbsp; The given vertex represents the new cell to be inserted.&nbsp; This invokes <a href="#mxDefaultToolbar.insert" class=LFunction id=link63 onMouseOver="ShowTip(event, 'tt22', 'link63')" onMouseOut="HideTip('tt22')">insert</a> or <a href="#mxDefaultToolbar.connect" class=LFunction id=link64 onMouseOver="ShowTip(event, 'tt23', 'link64')" onMouseOut="HideTip('tt23')">connect</a> depending on the given target cell.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link65 onMouseOver="ShowTip(event, 'tt30', 'link65')" onMouseOut="HideTip('tt30')">mxCell</a> to be inserted.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouse event that represents the drop.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link66 onMouseOver="ShowTip(event, 'tt30', 'link66')" onMouseOut="HideTip('tt30')">mxCell</a> that represents the drop target.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.insert"></a>insert</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.insert = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles a drop by inserting the given vertex into the given parent cell or the default parent if no parent is specified.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link67 onMouseOver="ShowTip(event, 'tt30', 'link67')" onMouseOut="HideTip('tt30')">mxCell</a> to be inserted.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouse event that represents the drop.</td></tr><tr><td class=CDLEntry>parent</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link68 onMouseOver="ShowTip(event, 'tt30', 'link68')" onMouseOut="HideTip('tt30')">mxCell</a> that represents the parent.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.connect"></a>connect</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.connect = function(</td><td class=PParameter nowrap>vertex,</td></tr><tr><td></td><td class=PParameter nowrap>evt,</td></tr><tr><td></td><td class=PParameter nowrap>source</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles a drop by connecting the given vertex to the given source cell.</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>vertex</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link69 onMouseOver="ShowTip(event, 'tt30', 'link69')" onMouseOut="HideTip('tt30')">mxCell</a> to be inserted.</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>Mouse event that represents the drop.</td></tr><tr><td class=CDLEntry>source</td><td class=CDLDescription>Optional <a href="../model/mxCell-js.html#mxCell" class=LClass id=link70 onMouseOver="ShowTip(event, 'tt30', 'link70')" onMouseOut="HideTip('tt30')">mxCell</a> that represents the source terminal.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.installDropHandler"></a>installDropHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.installDropHandler = function (</td><td class=PParameter nowrap>img,</td></tr><tr><td></td><td class=PParameter nowrap>dropHandler</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Makes the given img draggable using the given function for handling a drop event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>img</td><td class=CDLDescription>DOM node that represents the image.</td></tr><tr><td class=CDLEntry>dropHandler</td><td class=CDLDescription>Function that handles a drop of the image.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbar.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.destroy = function ()</td></tr></table></blockquote><p>Destroys the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link71 onMouseOver="ShowTip(event, 'tt4', 'link71')" onMouseOut="HideTip('tt4')">toolbar</a> associated with this object and removes all installed listeners.&nbsp; This does normally not need to be called, the <a href="#mxDefaultToolbar.toolbar" class=LVariable id=link72 onMouseOver="ShowTip(event, 'tt4', 'link72')" onMouseOut="HideTip('tt4')">toolbar</a> is destroyed automatically when the window unloads (in IE) by <a href="mxEditor-js.html#mxEditor" class=LClass id=link73 onMouseOver="ShowTip(event, 'tt3', 'link73')" onMouseOut="HideTip('tt3')">mxEditor</a>.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2013-11-18 15:18:56 +00:00
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxDefaultToolbar</div></div><div class=MEntry><div class=MFile><a href="mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPopupMenuHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-js.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjec
2012-05-21 20:32:26 +00:00
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([1], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxDefaultToolbar(</td><td class=PParameter nowrap>container,</td></tr><tr><td></td><td class=PParameter nowrap>editor</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new toolbar for the given container and editor. </div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.editor</td></tr></table></blockquote>Reference to the enclosing mxEditor.</div></div><div class=CToolTip id="tt3"><div class=CClass>Extends mxEventSource to implement a application wrapper for a graph that adds actions, I/O using mxCodec, auto-layout using mxLayoutManager, command history using undoManager, and standard dialogs and widgets, eg. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.toolbar</td></tr></table></blockquote>Holds the internal mxToolbar.</div></div><div class=CToolTip id="tt5"><div class=CClass>Creates a toolbar inside a given DOM node. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.resetHandler</td></tr></table></blockquote>Reference to the function used to reset the toolbar.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.spacing</td></tr></table></blockquote>Defines the spacing between existing and new vertices in gridSize units when a new vertex is dropped on an existing cell. </div></div><div class=CToolTip id="tt8"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.connectOnDrop</td></tr></table></blockquote>Specifies if elements should be connected if new cells are dropped onto connectable elements. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbar.prototype.init</td></tr></table></blockquote>Constructs the toolbar for the given container and installs a listener that updates the mxEditor.insertFunction on editor if an item is selected in the toolbar. </div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEditor.prototype.insertFunction</td></tr></table></blockquote>Specifies the function to be used for inserting new cells into the graph. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addItem = function(</td><td class=PParameter nowrap>title,</td></tr><tr><td></td><td class=PParameter nowrap>icon,</td></tr><tr><td></td><td class=PParameter nowrap>action,</td></tr><tr><td></td><td class=PParameter nowrap>pressed</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a new item that executes the given action in editor. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxDefaultToolbar.prototype.addSeparator = function(</td><td class=PParameter nowrap>icon</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds a vertical separator using t
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>