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

288 lines
15 KiB
HTML

<!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"/>
<title>mxGraph: com::mxgraph::mxStylesheet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<div class="navpath"><b>com</b>::<b>mxgraph</b>::<a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html">mxStylesheet</a>
</div>
</div>
<div class="contents">
<h1>com::mxgraph::mxStylesheet Class Reference</h1><!-- doxytag: class="com::mxgraph::mxStylesheet" -->
<p>Defines the appearance of the cells in a graph.
<a href="#_details">More...</a></p>
<p><a href="classcom_1_1mxgraph_1_1mxStylesheet-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a574c49950df28b41e2c3ea218acc2a3a">mxStylesheet</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructs a new stylesheet and assigns default styles. <a href="#a574c49950df28b41e2c3ea218acc2a3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ab349fa703d0689a6783a95ecc911324d">PutCellStyle</a> (string name, Dictionary&lt; string, Object &gt; style)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stores the specified style under the given name. <a href="#ab349fa703d0689a6783a95ecc911324d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#afc38d23edbde813698159ed5d62bf3b0">GetCellStyle</a> (string name, Dictionary&lt; string, Object &gt; defaultStyle)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#afc38d23edbde813698159ed5d62bf3b0"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#acda54608747d0d86a2fc5140cf8c1ff2">EMPTY_STYLE</a> = new Dictionary&lt;string, Object&gt;()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Shared immutable empty dictionary (for undefined cell styles). <a href="#acda54608747d0d86a2fc5140cf8c1ff2"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a6d347145ac52be5640d705a15d86bf54">CreateDefaultVertexStyle</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates and returns the default vertex style. <a href="#a6d347145ac52be5640d705a15d86bf54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ae65aab6b8095dbff81674b19a3d717ed">CreateDefaultEdgeStyle</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates and returns the default edge style. <a href="#ae65aab6b8095dbff81674b19a3d717ed"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Dictionary<br class="typebreak"/>
&lt; string, Object &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ac216dfa766b6ee9101d1cf00bc623f23">styles</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Maps from names to styles. <a href="#ac216dfa766b6ee9101d1cf00bc623f23"></a><br/></td></tr>
<tr><td colspan="2"><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Dictionary<br class="typebreak"/>
&lt; string, Object &gt; &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#aff79a561ec698762bb9eda9d883a4b88">Styles</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or returns the map that contains the styles. <a href="#aff79a561ec698762bb9eda9d883a4b88"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a8bea54671a04717f6d96d06427b5edd0">DefaultVertexStyle</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or returns the default style for vertices. <a href="#a8bea54671a04717f6d96d06427b5edd0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Dictionary&lt; string, Object &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#a55e72a75f417b6c0b29d548cc958c4b4">DefaultEdgeStyle</a><code> [get, set]</code></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets or returns the default style for edges. <a href="#a55e72a75f417b6c0b29d548cc958c4b4"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Defines the appearance of the cells in a graph. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a574c49950df28b41e2c3ea218acc2a3a"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::mxStylesheet" ref="a574c49950df28b41e2c3ea218acc2a3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">com::mxgraph::mxStylesheet::mxStylesheet </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<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>
<a class="anchor" id="ae65aab6b8095dbff81674b19a3d717ed"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::CreateDefaultEdgeStyle" ref="ae65aab6b8095dbff81674b19a3d717ed" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; com::mxgraph::mxStylesheet::CreateDefaultEdgeStyle </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<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>
<a class="anchor" id="a6d347145ac52be5640d705a15d86bf54"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::CreateDefaultVertexStyle" ref="a6d347145ac52be5640d705a15d86bf54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; com::mxgraph::mxStylesheet::CreateDefaultVertexStyle </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<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>
<a class="anchor" id="afc38d23edbde813698159ed5d62bf3b0"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::GetCellStyle" ref="afc38d23edbde813698159ed5d62bf3b0" args="(string name, Dictionary&lt; string, Object &gt; defaultStyle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; com::mxgraph::mxStylesheet::GetCellStyle </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&nbsp;</td>
<td class="paramname"> <em>defaultStyle</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</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>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>String of the form [(stylename|key=value);] that represents the style.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>defaultStyle</em>&nbsp;</td><td>Default style to be returned if no style can be found.</td></tr>
</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>
<a class="anchor" id="ab349fa703d0689a6783a95ecc911324d"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::PutCellStyle" ref="ab349fa703d0689a6783a95ecc911324d" args="(string name, Dictionary&lt; string, Object &gt; style)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void com::mxgraph::mxStylesheet::PutCellStyle </td>
<td>(</td>
<td class="paramtype">string&nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Dictionary&lt; string, Object &gt;&nbsp;</td>
<td class="paramname"> <em>style</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Stores the specified style under the given name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>Name for the style to be stored.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>style</em>&nbsp;</td><td>Key, value pairs that define the style.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="acda54608747d0d86a2fc5140cf8c1ff2"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::EMPTY_STYLE" ref="acda54608747d0d86a2fc5140cf8c1ff2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#acda54608747d0d86a2fc5140cf8c1ff2">com::mxgraph::mxStylesheet::EMPTY_STYLE</a> = new Dictionary&lt;string, Object&gt;()<code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Shared immutable empty dictionary (for undefined cell styles). </p>
</div>
</div>
<a class="anchor" id="ac216dfa766b6ee9101d1cf00bc623f23"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::styles" ref="ac216dfa766b6ee9101d1cf00bc623f23" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Dictionary&lt;string, Object&gt; &gt; <a class="el" href="classcom_1_1mxgraph_1_1mxStylesheet.html#ac216dfa766b6ee9101d1cf00bc623f23">com::mxgraph::mxStylesheet::styles</a><code> [protected]</code></td>
</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>
<a class="anchor" id="a55e72a75f417b6c0b29d548cc958c4b4"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::DefaultEdgeStyle" ref="a55e72a75f417b6c0b29d548cc958c4b4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; com::mxgraph::mxStylesheet::DefaultEdgeStyle<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the default style for edges. </p>
</div>
</div>
<a class="anchor" id="a8bea54671a04717f6d96d06427b5edd0"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::DefaultVertexStyle" ref="a8bea54671a04717f6d96d06427b5edd0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Object&gt; com::mxgraph::mxStylesheet::DefaultVertexStyle<code> [get, set]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets or returns the default style for vertices. </p>
</div>
</div>
<a class="anchor" id="aff79a561ec698762bb9eda9d883a4b88"></a><!-- doxytag: member="com::mxgraph::mxStylesheet::Styles" ref="aff79a561ec698762bb9eda9d883a4b88" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Dictionary&lt;string, Dictionary&lt;string, Object&gt; &gt; com::mxgraph::mxStylesheet::Styles<code> [get, set]</code></td>
</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>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri May 25 10:15:54 2012 for mxGraph by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>