maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxSt...

338 lines
17 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
2013-04-04 11:51:15 +00:00
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>mxGraph: com.mxgraph.mxStylesheet Class Reference</title>
2012-05-21 20:32:26 +00:00
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2013-04-04 11:51:15 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css" />
2012-05-21 20:32:26 +00:00
</head>
<body>
2013-04-04 11:51:15 +00:00
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxGraph
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
2012-05-21 20:32:26 +00:00
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
2013-04-04 11:51:15 +00:00
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
2012-05-21 20:32:26 +00:00
</ul>
</div>
2013-04-04 11:51:15 +00:00
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>com</b> </li>
<li class="navelem"><a class="el" href="namespacecom_1_1mxgraph.html">mxgraph</a> </li>
<li class="navelem"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html">mxStylesheet</a> </li>
</ul>
2012-05-21 20:32:26 +00:00
</div>
</div>
2013-04-04 11:51:15 +00:00
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxStylesheet Class Reference</div> </div>
</div><!--header-->
2012-05-21 20:32:26 +00:00
<div class="contents">
2013-04-04 11:51:15 +00:00
<!-- doxytag: class="com::mxgraph::mxStylesheet" -->
2012-05-21 20:32:26 +00:00
<p>Defines the appearance of the cells in a graph.
2013-04-04 11:51:15 +00:00
<a href="classcom_1_1mxgraph_1_1mxStylesheet.html#details">More...</a></p>
2012-05-21 20:32:26 +00:00
<p><a href="classcom_1_1mxgraph_1_1mxStylesheet-members.html">List of all members.</a></p>
2013-04-04 11:51:15 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a1bc12672c01cb1100c851f285a4e90c5">mxStylesheet</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new stylesheet and assigns default styles. <a href="#a1bc12672c01cb1100c851f285a4e90c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a49b6f444c064b14ba705fbab51ced3f3">PutCellStyle</a> (string name, Dictionary&lt; string, Object &gt; style)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the specified style under the given name. <a href="#a49b6f444c064b14ba705fbab51ced3f3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ae1e45fc8e6f94900d9ff0e1314d5e7e2">GetCellStyle</a> (string name, Dictionary&lt; string, Object &gt; defaultStyle)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the cell style for the specified cell or the given defaultStyle if no style can be found for the given stylename. <a href="#ae1e45fc8e6f94900d9ff0e1314d5e7e2"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a6d3fc5eb5ec70834205b1fa971118728">EMPTY_STYLE</a> = new Dictionary&lt;string, Object&gt;()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Shared immutable empty dictionary (for undefined cell styles). <a href="#a6d3fc5eb5ec70834205b1fa971118728"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ad1a60ea66ffbfa7df3fbc5f9d877590b">CreateDefaultVertexStyle</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns the default vertex style. <a href="#ad1a60ea66ffbfa7df3fbc5f9d877590b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a465011a55fc26fb80b0275bf9de9daff">CreateDefaultEdgeStyle</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates and returns the default edge style. <a href="#a465011a55fc26fb80b0275bf9de9daff"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
2012-05-21 20:32:26 +00:00
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Dictionary<br class="typebreak"/>
2013-04-04 11:51:15 +00:00
&lt; string, Object &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ad360729d67c23d6e5fa70927119de123">styles</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Maps from names to styles. <a href="#ad360729d67c23d6e5fa70927119de123"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="properties"></a>
Properties</h2></td></tr>
2012-05-21 20:32:26 +00:00
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Dictionary<br class="typebreak"/>
2013-04-04 11:51:15 +00:00
&lt; string, Object &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#aba69adc377677ea342f003ddbbd7062d">Styles</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or returns the map that contains the styles. <a href="#aba69adc377677ea342f003ddbbd7062d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#aa25261df1095324fd97876ffb05baff2">DefaultVertexStyle</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or returns the default style for vertices. <a href="#aa25261df1095324fd97876ffb05baff2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a54d4f6c8ae0da22a55772214c81160eb">DefaultEdgeStyle</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets or returns the default style for edges. <a href="#a54d4f6c8ae0da22a55772214c81160eb"></a><br/></td></tr>
2012-05-21 20:32:26 +00:00
</table>
2013-04-04 11:51:15 +00:00
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines the appearance of the cells in a graph. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1bc12672c01cb1100c851f285a4e90c5"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::mxStylesheet" ref="a1bc12672c01cb1100c851f285a4e90c5" args="()" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a1bc12672c01cb1100c851f285a4e90c5">com.mxgraph.mxStylesheet.mxStylesheet</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramname"></td><td>)</td>
2012-05-21 20:32:26 +00:00
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs a new stylesheet and assigns default styles. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a465011a55fc26fb80b0275bf9de9daff"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::CreateDefaultEdgeStyle" ref="a465011a55fc26fb80b0275bf9de9daff" args="()" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a465011a55fc26fb80b0275bf9de9daff">com.mxgraph.mxStylesheet.CreateDefaultEdgeStyle</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramname"></td><td>)</td>
2012-05-21 20:32:26 +00:00
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates and returns the default edge style. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the default edge style.</dd></dl>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="ad1a60ea66ffbfa7df3fbc5f9d877590b"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::CreateDefaultVertexStyle" ref="ad1a60ea66ffbfa7df3fbc5f9d877590b" args="()" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ad1a60ea66ffbfa7df3fbc5f9d877590b">com.mxgraph.mxStylesheet.CreateDefaultVertexStyle</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramname"></td><td>)</td>
2012-05-21 20:32:26 +00:00
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates and returns the default vertex style. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the default vertex style.</dd></dl>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="ae1e45fc8e6f94900d9ff0e1314d5e7e2"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::GetCellStyle" ref="ae1e45fc8e6f94900d9ff0e1314d5e7e2" args="(string name, Dictionary&lt; string, Object &gt; defaultStyle)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ae1e45fc8e6f94900d9ff0e1314d5e7e2">com.mxgraph.mxStylesheet.GetCellStyle</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>name</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Dictionary&lt; string, Object &gt;&#160;</td>
<td class="paramname"><em>defaultStyle</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td><code> [inline]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the cell style for the specified cell or the given defaultStyle if no style can be found for the given stylename. </p>
2013-04-04 11:51:15 +00:00
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>String of the form [(stylename|key=value);] that represents the style.</td></tr>
<tr><td class="paramname">defaultStyle</td><td>Default style to be returned if no style can be found.</td></tr>
2012-05-21 20:32:26 +00:00
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Returns the style for the given formatted cell style.</dd></dl>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a49b6f444c064b14ba705fbab51ced3f3"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::PutCellStyle" ref="a49b6f444c064b14ba705fbab51ced3f3" args="(string name, Dictionary&lt; string, Object &gt; style)" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">void <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a49b6f444c064b14ba705fbab51ced3f3">com.mxgraph.mxStylesheet.PutCellStyle</a> </td>
2012-05-21 20:32:26 +00:00
<td>(</td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>name</em>, </td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
2013-04-04 11:51:15 +00:00
<td class="paramtype">Dictionary&lt; string, Object &gt;&#160;</td>
<td class="paramname"><em>style</em>&#160;</td>
2012-05-21 20:32:26 +00:00
</tr>
<tr>
<td></td>
<td>)</td>
2013-04-04 11:51:15 +00:00
<td></td><td><code> [inline]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores the specified style under the given name. </p>
2013-04-04 11:51:15 +00:00
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name for the style to be stored.</td></tr>
<tr><td class="paramname">style</td><td>Key, value pairs that define the style.</td></tr>
2012-05-21 20:32:26 +00:00
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a6d3fc5eb5ec70834205b1fa971118728"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::EMPTY_STYLE" ref="a6d3fc5eb5ec70834205b1fa971118728" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a6d3fc5eb5ec70834205b1fa971118728">com.mxgraph.mxStylesheet.EMPTY_STYLE</a> = new Dictionary&lt;string, Object&gt;()<code> [static]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Shared immutable empty dictionary (for undefined cell styles). </p>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="ad360729d67c23d6e5fa70927119de123"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::styles" ref="ad360729d67c23d6e5fa70927119de123" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Dictionary&lt;string, Object&gt; &gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ad360729d67c23d6e5fa70927119de123">com.mxgraph.mxStylesheet.styles</a><code> [protected]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment">
<span class="keyword">new</span> Dictionary&lt;string, Dictionary&lt;string, Object&gt;&gt;()
</pre></div>
<p>Maps from names to styles. </p>
</div>
</div>
<hr/><h2>Property Documentation</h2>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="a54d4f6c8ae0da22a55772214c81160eb"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::DefaultEdgeStyle" ref="a54d4f6c8ae0da22a55772214c81160eb" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a54d4f6c8ae0da22a55772214c81160eb">com.mxgraph.mxStylesheet.DefaultEdgeStyle</a><code> [get, set]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the default style for edges. </p>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="aa25261df1095324fd97876ffb05baff2"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::DefaultVertexStyle" ref="aa25261df1095324fd97876ffb05baff2" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#aa25261df1095324fd97876ffb05baff2">com.mxgraph.mxStylesheet.DefaultVertexStyle</a><code> [get, set]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the default style for vertices. </p>
</div>
</div>
2013-04-04 11:51:15 +00:00
<a class="anchor" id="aba69adc377677ea342f003ddbbd7062d"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::Styles" ref="aba69adc377677ea342f003ddbbd7062d" args="" -->
2012-05-21 20:32:26 +00:00
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
2013-04-04 11:51:15 +00:00
<td class="memname">Dictionary&lt;string, Dictionary&lt;string, Object&gt; &gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#aba69adc377677ea342f003ddbbd7062d">com.mxgraph.mxStylesheet.Styles</a><code> [get, set]</code></td>
2012-05-21 20:32:26 +00:00
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the map that contains the styles. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/view/mxStylesheet.cs</li>
</ul>
2013-04-04 11:51:15 +00:00
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
2013-08-09 09:08:09 +00:00
Generated on Fri Aug 9 2013 10:05:13 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
2013-04-04 11:51:15 +00:00
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
2012-05-21 20:32:26 +00:00
</body>
</html>