maxGraph/docs/js-api/files/io/mxDefaultToolbarCodec-js.html

70 lines
32 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>mxDefaultToolbarCodec</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 -->
2014-10-03 12:49:36 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxDefaultToolbarCodec"></a>mxDefaultToolbarCodec</h1><div class=CBody><p>Custom codec for configuring <a href="../editor/mxDefaultToolbar-js.html#mxDefaultToolbar" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt1', 'link5')" onMouseOut="HideTip('tt1')">mxDefaultToolbar</a>s.&nbsp; This class is created and registered dynamically at load time and used implicitely via <a href="mxCodec-js.html#mxCodec" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">mxCodec</a> and the <a href="mxCodecRegistry-js.html#mxCodecRegistry" class=LClass id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">mxCodecRegistry</a>.&nbsp; This codec only reads configuration data for existing toolbars handlers, it does not encode or create toolbars.</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="#mxDefaultToolbarCodec" >mxDefaultToolbarCodec</a></td><td class=SDescription>Custom codec for configuring <a href="../editor/mxDefaultToolbar-js.html#mxDefaultToolbar" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxDefaultToolbar</a>s. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxDefaultToolbarCodec.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbarCodec.encode" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">encode</a></td><td class=SDescription>Returns null.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxDefaultToolbarCodec.decode" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">decode</a></td><td class=SDescription>Reads a sequence of the following child nodes and attributes:</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxDefaultToolbarCodec.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxDefaultToolbarCodec.allowEval" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">allowEval</a></td><td class=SDescription>Static global switch that specifies if the use of eval is allowed for evaluating text content. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbarCodec.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbarCodec.encode"></a>encode</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>codec.encode = function(</td><td class=PParameter nowrap>enc,</td></tr><tr><td></td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns null.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbarCodec.decode"></a>decode</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>codec.decode = function(</td><td class=PParameter nowrap>dec,</td></tr><tr><td></td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>into</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Reads a sequence of the following child nodes and attributes:</p><h4 class=CHeading>Child Nodes</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>add</td><td class=CDLDescription>Adds a new item to the toolbar.&nbsp; See below for attributes.</td></tr><tr><td class=CDLEntry>separator</td><td class=CDLDescription>Adds a vertical separator.&nbsp; No attributes.</td></tr><tr><td class=CDLEntry>hr</td><td class=CDLDescription>Adds a horizontal separator.&nbsp; No attributes.</td></tr><tr><td class=CDLEntry>br</td><td class=CDLDescription>Adds a linefeed.&nbsp; No attributes.</td></tr></table><h4 class=CHeading>Attributes</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>as</td><td class=CDLDescription>Resource key for the label.</td></tr><tr><td class=CDLEntry>action</td><td class=CDLDescription>Name of the action to execute in enclosing editor.</td></tr><tr><td class=CDLEntry>mode</td><td class=CDLDescription>Modename (see below).</td></tr><tr><td class=CDLEntry>template</td><td class=CDLDescription>Template name for cell insertion.</td></tr><tr><td class=CDLEntry>style</td><td class=CDLDescription>Optional style to override the template style.</td></tr><tr><td class=CDLEntry>icon</td><td class=CDLDescription>Icon (relative/absolute URL).</td></tr><tr><td class=CDLEntry>pressedIcon</td><td class=CDLDescription>Optional icon for pressed state (relative/absolute URL).</td></tr><tr><td class=CDLEntry>id</td><td class=CDLDescription>Optional ID to be used for the created DOM element.</td></tr><tr><td class=CDLEntry>toggle</td><td class=CDLDescription>Optional 0 or 1 to disable toggling of the element.&nbsp; Default is 1 (true).</td></tr></table><p>The action, mode and template attributes are mutually exclusive.&nbsp; The style can only be used with the template attribute.&nbsp; The add node may contain another sequence of add nodes with as and action attributes to create a combo box in the toolbar.&nbsp; If the icon is specified then a list of the child node is expected to have its template attribute set and the action is ignored instead.</p><p>Nodes with a specified template may define a function to be used for inserting the cloned template into the graph.&nbsp; Here is an example of such a node:</p><blockquote><pre class="prettyprint">&lt;add as=&quot;Swimlane&quot; template=&quot;swimlane&quot; icon=&quot;images/swimlane.gif&quot;&gt;&lt;![CDATA[
function (editor, cell, evt, targetCell)
{
var pt = mxUtils.convertPoint(
editor.graph.container, mxEvent.getClientX(evt),
mxEvent.getClientY(evt));
return editor.addVertex(targetCell, cell, pt.x, pt.y);
}
2014-10-03 12:49:36 +00:00
]]&gt;&lt;/add&gt;</pre></blockquote><p>In the above function, editor is the enclosing <a href="../editor/mxEditor-js.html#mxEditor" class=LClass id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">mxEditor</a> instance, cell is the clone of the template, evt is the mouse event that represents the drop and targetCell is the cell under the mousepointer where the drop occurred.&nbsp; The targetCell is retrieved using <a href="../view/mxGraph-js.html#mxGraph.getCellAt" class=LFunction id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">mxGraph.getCellAt</a>.</p><p>Futhermore, nodes with the mode attribute may define a function to be executed upon selection of the respective toolbar icon.&nbsp; In the example below, the default edge style is set when this specific connect-mode is activated:</p><blockquote><pre class="prettyprint">&lt;add as=&quot;connect&quot; mode=&quot;connect&quot;&gt;&lt;![CDATA[
2012-05-21 20:32:26 +00:00
function (editor)
{
if (editor.defaultEdge != null)
{
editor.defaultEdge.style = 'straightEdge';
}
}
2014-10-03 12:49:36 +00:00
]]&gt;&lt;/add&gt;</pre></blockquote><p>Both functions require <a href="#mxDefaultToolbarCodec.allowEval" class=LVariable id=link10 onMouseOver="ShowTip(event, 'tt4', 'link10')" onMouseOut="HideTip('tt4')">mxDefaultToolbarCodec.allowEval</a> to be set to true.</p><h4 class=CHeading>Modes</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>select</td><td class=CDLDescription>Left mouse button used for rubberband- &amp; cell-selection.</td></tr><tr><td class=CDLEntry>connect</td><td class=CDLDescription>Allows connecting vertices by inserting new edges.</td></tr><tr><td class=CDLEntry>pan</td><td class=CDLDescription>Disables selection and switches to panning on the left button.</td></tr></table><h4 class=CHeading>Example</h4><h4 class=CHeading>To add items to the toolbar</h4><blockquote><pre class="prettyprint">&lt;mxDefaultToolbar as=&quot;toolbar&quot;&gt;
2012-05-21 20:32:26 +00:00
&lt;add as=&quot;save&quot; action=&quot;save&quot; icon=&quot;images/save.gif&quot;/&gt;
&lt;br/&gt;&lt;hr/&gt;
&lt;add as=&quot;select&quot; mode=&quot;select&quot; icon=&quot;images/select.gif&quot;/&gt;
&lt;add as=&quot;connect&quot; mode=&quot;connect&quot; icon=&quot;images/connect.gif&quot;/&gt;
&lt;/mxDefaultToolbar&gt;</pre></blockquote></div></div></div>
2014-10-03 12:49:36 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbarCodec.Variables"></a>Variables</h3></div></div>
2015-03-13 08:29:11 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxDefaultToolbarCodec.allowEval"></a>allowEval</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbarCodec.allowEval</td></tr></table></blockquote><p>Static global switch that specifies if the use of eval is allowed for evaluating text content.&nbsp; Default is true.&nbsp; Set this to false if stylesheets may contain user input</p></div></div></div>
2014-10-03 12:49:36 +00:00
2012-05-21 20:32:26 +00:00
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2015-03-13 08:29:11 +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="../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../editor/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/mxHandle-js.html">mxHandle</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/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPopupMenuHandler-js.html">mxPopupMenuHandler</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="mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxDefaultToolbarCodec</div></div><div class=MEntry><div class=MFile><a href="mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="mxModelCodec-js.html">mxModelCodec</a></div><
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([3], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
2014-10-03 12:49:36 +00:00
<div class=CToolTip id="tt1"><div class=CClass>Toolbar for the editor. </div></div><div class=CToolTip id="tt2"><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>codec.encode = function(</td><td class=PParameter nowrap>enc,</td></tr><tr><td></td><td class=PParameter nowrap>obj</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns null.</div></div><div class=CToolTip id="tt3"><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>codec.decode = function(</td><td class=PParameter nowrap>dec,</td></tr><tr><td></td><td class=PParameter nowrap>node,</td></tr><tr><td></td><td class=PParameter nowrap>into</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Reads a sequence of the following child nodes and attributes:</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxDefaultToolbarCodec.allowEval</td></tr></table></blockquote>Static global switch that specifies if the use of eval is allowed for evaluating text content. </div></div><div class=CToolTip id="tt5"><div class=CClass>XML codec for JavaScript object graphs. </div></div><div class=CToolTip id="tt6"><div class=CClass>Singleton class that acts as a global registry for codecs.</div></div><div class=CToolTip id="tt7"><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="tt8"><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>mxGraph.prototype.getCellAt = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>parent,</td></tr><tr><td></td><td class=PParameter nowrap>vertices,</td></tr><tr><td></td><td class=PParameter nowrap>edges</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the bottom-most cell that intersects the given point (x, y) in the cell hierarchy starting at the given parent. </div></div><!--END_ND_TOOLTIPS-->
2012-05-21 20:32:26 +00:00
<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>