155 lines
79 KiB
HTML
155 lines
79 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CellEditorHandler | @maxgraph/core</title><meta name="description" content="Documentation for @maxgraph/core"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@maxgraph/core</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">@maxgraph/core</a></li><li><a href="CellEditorHandler.html">CellEditorHandler</a></li></ul><h1>Class CellEditorHandler</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>In-place editor for the graph. To control this editor, use
|
|
{@link Graph#invokesStopCellEditing}, {@link Graph#enterStopsCellEditing} and
|
|
{@link Graph#escapeEnabled}. If {@link Graph#enterStopsCellEditing} is true then
|
|
ctrl-enter or shift-enter can be used to create a linefeed. The F2 and
|
|
escape keys can always be used to stop editing.</p>
|
|
</div><div><p>To customize the location of the textbox in the graph, override
|
|
<getEditorBounds> as follows:</p>
|
|
<pre><code class="language-javascript"><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">cellEditor</span><span class="hl-1">.</span><span class="hl-2">getEditorBounds</span><span class="hl-1"> = (</span><span class="hl-0">state</span><span class="hl-1">)</span><span class="hl-3">=></span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">result</span><span class="hl-1"> = </span><span class="hl-0">getEditorBounds</span><span class="hl-1">.</span><span class="hl-2">apply</span><span class="hl-1">(</span><span class="hl-3">this</span><span class="hl-1">, </span><span class="hl-3">arguments</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">getDataModel</span><span class="hl-1">().</span><span class="hl-2">isEdge</span><span class="hl-1">(</span><span class="hl-0">state</span><span class="hl-1">.</span><span class="hl-0">cell</span><span class="hl-1">))</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">result</span><span class="hl-1">.</span><span class="hl-0">x</span><span class="hl-1"> = </span><span class="hl-0">state</span><span class="hl-1">.</span><span class="hl-2">getCenterX</span><span class="hl-1">() - </span><span class="hl-0">result</span><span class="hl-1">.</span><span class="hl-0">width</span><span class="hl-1"> / </span><span class="hl-8">2</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">result</span><span class="hl-1">.</span><span class="hl-0">y</span><span class="hl-1"> = </span><span class="hl-0">state</span><span class="hl-1">.</span><span class="hl-2">getCenterY</span><span class="hl-1">() - </span><span class="hl-0">result</span><span class="hl-1">.</span><span class="hl-0">height</span><span class="hl-1"> / </span><span class="hl-8">2</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-5">return</span><span class="hl-1"> </span><span class="hl-0">result</span><span class="hl-1">;</span><br/><span class="hl-1">};</span>
|
|
</code></pre>
|
|
<p>Note that this hook is only called if <autoSize> is false. If <autoSize> is true,
|
|
then {@link Shape#getLabelBounds} is used to compute the current bounds of the textbox.</p>
|
|
<p>The textarea uses the mxCellEditor CSS class. You can modify this class in
|
|
your custom CSS. Note: You should modify the CSS after loading the client
|
|
in the page.</p>
|
|
<p>Example:</p>
|
|
<p>To only allow numeric input in the in-place editor, use the following code.</p>
|
|
<pre><code class="language-javascript"><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">text</span><span class="hl-1"> = </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">cellEditor</span><span class="hl-1">.</span><span class="hl-0">textarea</span><span class="hl-1">;</span><br/><br/><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">addListener</span><span class="hl-1">(</span><span class="hl-0">text</span><span class="hl-1">, </span><span class="hl-6">'keydown'</span><span class="hl-1">, </span><span class="hl-3">function</span><span class="hl-1"> (</span><span class="hl-0">evt</span><span class="hl-1">)</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (!(</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</span><span class="hl-1"> >= </span><span class="hl-8">48</span><span class="hl-1"> && </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</span><span class="hl-1"> <= </span><span class="hl-8">57</span><span class="hl-1">) &&</span><br/><span class="hl-1"> !(</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</span><span class="hl-1"> >= </span><span class="hl-8">96</span><span class="hl-1"> && </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">keyCode</span><span class="hl-1"> <= </span><span class="hl-8">105</span><span class="hl-1">))</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">consume</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
</code></pre>
|
|
<p>Placeholder:</p>
|
|
<p>To implement a placeholder for cells without a label, use the
|
|
<emptyLabelText> variable.</p>
|
|
<p>Resize in Chrome:</p>
|
|
<p>Resize of the textarea is disabled by default. If you want to enable
|
|
this feature extend <init> and set this.textarea.style.resize = ''.</p>
|
|
<p>To start editing on a key press event, the container of the graph
|
|
should have focus or a focusable parent should be used to add the
|
|
key press handler as follows.</p>
|
|
<pre><code class="language-javascript"><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">addListener</span><span class="hl-1">(</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">container</span><span class="hl-1">, </span><span class="hl-6">'keypress'</span><span class="hl-1">, </span><span class="hl-0">mxUtils</span><span class="hl-1">.</span><span class="hl-2">bind</span><span class="hl-1">(</span><span class="hl-3">this</span><span class="hl-1">, (</span><span class="hl-0">evt</span><span class="hl-1">)</span><span class="hl-3">=></span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (!</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">isEditing</span><span class="hl-1">() && !</span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">isSelectionEmpty</span><span class="hl-1">() && </span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">which</span><span class="hl-1"> !== </span><span class="hl-8">0</span><span class="hl-1"> &&</span><br/><span class="hl-1"> !</span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">isAltDown</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">) && !</span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">isControlDown</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">) && !</span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-2">isMetaDown</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">))</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">startEditing</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">Client</span><span class="hl-1">.</span><span class="hl-7">IS_FF</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">cellEditor</span><span class="hl-1">.</span><span class="hl-0">textarea</span><span class="hl-1">.</span><span class="hl-0">value</span><span class="hl-1"> = </span><span class="hl-10">String</span><span class="hl-1">.</span><span class="hl-2">fromCharCode</span><span class="hl-1">(</span><span class="hl-0">evt</span><span class="hl-1">.</span><span class="hl-0">which</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}));</span>
|
|
</code></pre>
|
|
<p>To allow focus for a DIV, and hence to receive key press events, some browsers
|
|
require it to have a valid tabindex attribute. In this case the following
|
|
code may be used to keep the container focused.</p>
|
|
<pre><code class="language-javascript"><span class="hl-3">let</span><span class="hl-1"> </span><span class="hl-0">graphFireMouseEvent</span><span class="hl-1"> = </span><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-0">fireMouseEvent</span><span class="hl-1">;</span><br/><span class="hl-0">graph</span><span class="hl-1">.</span><span class="hl-2">fireMouseEvent</span><span class="hl-1"> = (</span><span class="hl-0">evtName</span><span class="hl-1">, </span><span class="hl-0">me</span><span class="hl-1">, </span><span class="hl-0">sender</span><span class="hl-1">)</span><span class="hl-3">=></span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">if</span><span class="hl-1"> (</span><span class="hl-0">evtName</span><span class="hl-1"> == </span><span class="hl-0">mxEvent</span><span class="hl-1">.</span><span class="hl-7">MOUSE_DOWN</span><span class="hl-1">)</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">this</span><span class="hl-1">.</span><span class="hl-0">container</span><span class="hl-1">.</span><span class="hl-2">focus</span><span class="hl-1">();</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-0">graphFireMouseEvent</span><span class="hl-1">.</span><span class="hl-2">apply</span><span class="hl-1">(</span><span class="hl-3">this</span><span class="hl-1">, </span><span class="hl-3">arguments</span><span class="hl-1">);</span><br/><span class="hl-1">};</span>
|
|
</code></pre>
|
|
<p>Constructor: mxCellEditor</p>
|
|
<p>Constructs a new in-place editor for the specified graph.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>param graph</dt><dd><p>Reference to the enclosing <a href="Graph.html">Graph</a>.</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CellEditorHandler</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">GraphPlugin</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CellEditorHandler.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#align" class="tsd-kind-icon">align</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#autoSize" class="tsd-kind-icon">auto<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#blurEnabled" class="tsd-kind-icon">blur<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#bounds" class="tsd-kind-icon">bounds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#changeHandler" class="tsd-kind-icon">change<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#clearOnChange" class="tsd-kind-icon">clear<wbr/>On<wbr/>Change</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#editingCell" class="tsd-kind-icon">editing<wbr/>Cell</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#emptyLabelText" class="tsd-kind-icon">empty<wbr/>Label<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#escapeCancelsEditing" class="tsd-kind-icon">escape<wbr/>Cancels<wbr/>Editing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#initialValue" class="tsd-kind-icon">initial<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#minResize" class="tsd-kind-icon">min<wbr/>Resize</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#modified" class="tsd-kind-icon">modified</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#resizeThread" class="tsd-kind-icon">resize<wbr/>Thread</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#selectText" class="tsd-kind-icon">select<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textDirection" class="tsd-kind-icon">text<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textNode" class="tsd-kind-icon">text<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textarea" class="tsd-kind-icon">textarea</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#trigger" class="tsd-kind-icon">trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#wordWrapPadding" class="tsd-kind-icon">word<wbr/>Wrap<wbr/>Padding</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#zIndex" class="tsd-kind-icon">z<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#zoomHandler" class="tsd-kind-icon">zoom<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CellEditorHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#applyValue" class="tsd-kind-icon">apply<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#focusLost" class="tsd-kind-icon">focus<wbr/>Lost</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getBackgroundColor" class="tsd-kind-icon">get<wbr/>Background<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getCurrentValue" class="tsd-kind-icon">get<wbr/>Current<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEditingCell" class="tsd-kind-icon">get<wbr/>Editing<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEditorBounds" class="tsd-kind-icon">get<wbr/>Editor<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEmptyLabelText" class="tsd-kind-icon">get<wbr/>Empty<wbr/>Label<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getInitialValue" class="tsd-kind-icon">get<wbr/>Initial<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getMinimumSize" class="tsd-kind-icon">get<wbr/>Minimum<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#installListeners" class="tsd-kind-icon">install<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isCancelEditingKeyEvent" class="tsd-kind-icon">is<wbr/>Cancel<wbr/>Editing<wbr/>Key<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isEventSource" class="tsd-kind-icon">is<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isHideLabel" class="tsd-kind-icon">is<wbr/>Hide<wbr/>Label</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isSelectText" class="tsd-kind-icon">is<wbr/>Select<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isStopEditingEvent" class="tsd-kind-icon">is<wbr/>Stop<wbr/>Editing<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#prepareTextarea" class="tsd-kind-icon">prepare<wbr/>Textarea</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#resize" class="tsd-kind-icon">resize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#setAlign" class="tsd-kind-icon">set<wbr/>Align</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#startEditing" class="tsd-kind-icon">start<wbr/>Editing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#stopEditing" class="tsd-kind-icon">stop<wbr/>Editing</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Cell<wbr/>Editor<wbr/>Handler<span class="tsd-signature-symbol">(</span>graph<span class="tsd-signature-symbol">: </span><a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CellEditorHandler.html" class="tsd-signature-type" data-tsd-kind="Class">CellEditorHandler</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L154">view/handler/CellEditorHandler.ts:154</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>graph: <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="CellEditorHandler.html" class="tsd-signature-type" data-tsd-kind="Class">CellEditorHandler</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="align" class="tsd-anchor"></a><h3>align</h3><div class="tsd-signature tsd-kind-icon">align<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L292">view/handler/CellEditorHandler.ts:292</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the current temporary horizontal alignment for the cell style. If this
|
|
is modified then the current text alignment is changed and the cell style is
|
|
updated when the value is applied.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="autoSize" class="tsd-anchor"></a><h3>auto<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">auto<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L223">view/handler/CellEditorHandler.ts:223</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the textarea should be resized while the text is being edited.
|
|
Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="blurEnabled" class="tsd-anchor"></a><h3>blur<wbr/>Enabled</h3><div class="tsd-signature tsd-kind-icon">blur<wbr/>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L279">view/handler/CellEditorHandler.ts:279</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If <focusLost> should be called if <textarea> loses the focus. Default is false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="bounds" class="tsd-anchor"></a><h3>bounds</h3><div class="tsd-signature tsd-kind-icon">bounds<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L183">view/handler/CellEditorHandler.ts:183</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="changeHandler" class="tsd-anchor"></a><h3>change<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">change<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L177">view/handler/CellEditorHandler.ts:177</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>sender<span class="tsd-signature-symbol">: </span><a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>sender: <a href="EventSource.html" class="tsd-signature-type" data-tsd-kind="Class">EventSource</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="clearOnChange" class="tsd-anchor"></a><h3>clear<wbr/>On<wbr/>Change</h3><div class="tsd-signature tsd-kind-icon">clear<wbr/>On<wbr/>Change<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L181">view/handler/CellEditorHandler.ts:181</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="editingCell" class="tsd-anchor"></a><h3>editing<wbr/>Cell</h3><div class="tsd-signature tsd-kind-icon">editing<wbr/>Cell<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L204">view/handler/CellEditorHandler.ts:204</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the <Cell> that is currently being edited.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="emptyLabelText" class="tsd-anchor"></a><h3>empty<wbr/>Label<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">empty<wbr/>Label<wbr/>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L240">view/handler/CellEditorHandler.ts:240</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Text to be displayed for empty labels. Default is '' or '<br>' in Firefox as
|
|
a workaround for the missing cursor bug for empty content editable. This can
|
|
be set to eg. "[Type Here]" to easier visualize editing of empty labels. The
|
|
value is only displayed before the first keystroke and is never used as the
|
|
actual editing value.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="escapeCancelsEditing" class="tsd-anchor"></a><h3>escape<wbr/>Cancels<wbr/>Editing</h3><div class="tsd-signature tsd-kind-icon">escape<wbr/>Cancels<wbr/>Editing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L248">view/handler/CellEditorHandler.ts:248</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true, pressing the escape key will stop editing and not accept the new
|
|
value. Change this to false to accept the new value on escape, and cancel
|
|
editing on Shift+Escape instead. Default is true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="graph" class="tsd-anchor"></a><h3>graph</h3><div class="tsd-signature tsd-kind-icon">graph<span class="tsd-signature-symbol">:</span> <a href="Graph.html" class="tsd-signature-type" data-tsd-kind="Class">Graph</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L192">view/handler/CellEditorHandler.ts:192</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the enclosing <a href="Graph.html">Graph</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="initialValue" class="tsd-anchor"></a><h3>initial<wbr/>Value</h3><div class="tsd-signature tsd-kind-icon">initial<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L285">view/handler/CellEditorHandler.ts:285</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the initial editing value to check if the current value was modified.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="minResize" class="tsd-anchor"></a><h3>min<wbr/>Resize</h3><div class="tsd-signature tsd-kind-icon">min<wbr/>Resize<span class="tsd-signature-symbol">:</span> <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L266">view/handler/CellEditorHandler.ts:266</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Defines the minimum width and height to be used in <resize>. Default is 0x20px.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="modified" class="tsd-anchor"></a><h3>modified</h3><div class="tsd-signature tsd-kind-icon">modified<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L216">view/handler/CellEditorHandler.ts:216</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the label has been modified.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="resizeThread" class="tsd-anchor"></a><h3>resize<wbr/>Thread</h3><div class="tsd-signature tsd-kind-icon">resize<wbr/>Thread<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L185">view/handler/CellEditorHandler.ts:185</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="selectText" class="tsd-anchor"></a><h3>select<wbr/>Text</h3><div class="tsd-signature tsd-kind-icon">select<wbr/>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L230">view/handler/CellEditorHandler.ts:230</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies if the text should be selected when editing starts. Default is
|
|
true.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="textDirection" class="tsd-anchor"></a><h3>text<wbr/>Direction</h3><div class="tsd-signature tsd-kind-icon">text<wbr/>Direction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">""</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"ltr"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rtl"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"auto"</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L187">view/handler/CellEditorHandler.ts:187</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="textNode" class="tsd-anchor"></a><h3>text<wbr/>Node</h3><div class="tsd-signature tsd-kind-icon">text<wbr/>Node<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">SVGGElement</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L254">view/handler/CellEditorHandler.ts:254</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the label DOM node that has been hidden.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="textarea" class="tsd-anchor"></a><h3>textarea</h3><div class="tsd-signature tsd-kind-icon">textarea<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L198">view/handler/CellEditorHandler.ts:198</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Holds the DIV that is used for text editing. Note that this may be null before the first
|
|
edit. Instantiated in <init>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="trigger" class="tsd-anchor"></a><h3>trigger</h3><div class="tsd-signature tsd-kind-icon">trigger<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> | </span><a href="InternalMouseEvent.html" class="tsd-signature-type" data-tsd-kind="Class">InternalMouseEvent</a><span class="tsd-signature-symbol"> = null</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L210">view/handler/CellEditorHandler.ts:210</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Reference to the event that was used to start editing.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="wordWrapPadding" class="tsd-anchor"></a><h3>word<wbr/>Wrap<wbr/>Padding</h3><div class="tsd-signature tsd-kind-icon">word<wbr/>Wrap<wbr/>Padding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L273">view/handler/CellEditorHandler.ts:273</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Correction factor for word wrapping width. Default is 2 in quirks, 0 in IE
|
|
11 and 1 in all other browsers and modes.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="zIndex" class="tsd-anchor"></a><h3>z<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">z<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 5</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L260">view/handler/CellEditorHandler.ts:260</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Specifies the zIndex for the textarea. Default is 5.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="zoomHandler" class="tsd-anchor"></a><h3>zoom<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">zoom<wbr/>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L179">view/handler/CellEditorHandler.ts:179</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static"><a id="pluginId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> plugin<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">plugin<wbr/>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = 'CellEditorHandler'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L152">view/handler/CellEditorHandler.ts:152</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="applyValue" class="tsd-anchor"></a><h3>apply<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">apply<wbr/>Value<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L316">view/handler/CellEditorHandler.ts:316</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Called in <stopEditing> if cancel is false to invoke {@link Graph#labelChanged}.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>value: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="focusLost" class="tsd-anchor"></a><h3>focus<wbr/>Lost</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">focus<wbr/>Lost<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L676">view/handler/CellEditorHandler.ts:676</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Called if the textarea has lost focus.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getBackgroundColor" class="tsd-anchor"></a><h3>get<wbr/>Background<wbr/>Color</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Background<wbr/>Color<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L684">view/handler/CellEditorHandler.ts:684</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the background color for the in-place editor. This implementation
|
|
always returns NONE.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getCurrentValue" class="tsd-anchor"></a><h3>get<wbr/>Current<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Current<wbr/>Value<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L344">view/handler/CellEditorHandler.ts:344</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the current editing value.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEditingCell" class="tsd-anchor"></a><h3>get<wbr/>Editing<wbr/>Cell</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Editing<wbr/>Cell<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L1058">view/handler/CellEditorHandler.ts:1058</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the cell that is currently being edited or null if no cell is
|
|
being edited.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEditorBounds" class="tsd-anchor"></a><h3>get<wbr/>Editor<wbr/>Bounds</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Editor<wbr/>Bounds<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L931">view/handler/CellEditorHandler.ts:931</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the <a href="Rectangle.html">Rectangle</a> that defines the bounds of the editor.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getEmptyLabelText" class="tsd-anchor"></a><h3>get<wbr/>Empty<wbr/>Label<wbr/>Text</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Empty<wbr/>Label<wbr/>Text<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L1050">view/handler/CellEditorHandler.ts:1050</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the initial label value to be used of the label of the given
|
|
cell is empty. This label is displayed and cleared on the first keystroke.
|
|
This implementation returns <emptyLabelText>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> for which a text for an empty editing box should be
|
|
returned.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getInitialValue" class="tsd-anchor"></a><h3>get<wbr/>Initial<wbr/>Value</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Initial<wbr/>Value<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a>, trigger<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L335">view/handler/CellEditorHandler.ts:335</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Gets the initial editing value for the given cell.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li><li><h5>trigger: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getMinimumSize" class="tsd-anchor"></a><h3>get<wbr/>Minimum<wbr/>Size</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Minimum<wbr/>Size<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L916">view/handler/CellEditorHandler.ts:916</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the minimum width and height for editing the given state.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="Rectangle.html" class="tsd-signature-type" data-tsd-kind="Class">Rectangle</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="init" class="tsd-anchor"></a><h3>init</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">init<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L298">view/handler/CellEditorHandler.ts:298</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates the <textarea> and installs the event listeners. The key handler
|
|
updates the {@link odified} state.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="installListeners" class="tsd-anchor"></a><h3>install<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">install<wbr/>Listeners<span class="tsd-signature-symbol">(</span>elt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HTMLElement</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L368">view/handler/CellEditorHandler.ts:368</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Installs listeners for focus, change and standard key event handling.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>elt: <span class="tsd-signature-type">HTMLElement</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isCancelEditingKeyEvent" class="tsd-anchor"></a><h3>is<wbr/>Cancel<wbr/>Editing<wbr/>Key<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Cancel<wbr/>Editing<wbr/>Key<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">KeyboardEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L355">view/handler/CellEditorHandler.ts:355</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if <escapeCancelsEditing> is true and shift, control and meta
|
|
are not pressed.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">KeyboardEvent</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isEventSource" class="tsd-anchor"></a><h3>is<wbr/>Event<wbr/>Source</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Event<wbr/>Source<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">KeyboardEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L480">view/handler/CellEditorHandler.ts:480</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if this editor is the source for the given native event.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">KeyboardEvent</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isHideLabel" class="tsd-anchor"></a><h3>is<wbr/>Hide<wbr/>Label</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Hide<wbr/>Label<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L909">view/handler/CellEditorHandler.ts:909</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the label should be hidden while the cell is being
|
|
edited.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>state: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="CellState.html" class="tsd-signature-type" data-tsd-kind="Class">CellState</a><span class="tsd-signature-symbol"> = null</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isSelectText" class="tsd-anchor"></a><h3>is<wbr/>Select<wbr/>Text</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Select<wbr/>Text<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L824">view/handler/CellEditorHandler.ts:824</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns <selectText>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="isStopEditingEvent" class="tsd-anchor"></a><h3>is<wbr/>Stop<wbr/>Editing<wbr/>Event</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">is<wbr/>Stop<wbr/>Editing<wbr/>Event<span class="tsd-signature-symbol">(</span>evt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">KeyboardEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L467">view/handler/CellEditorHandler.ts:467</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns true if the given keydown event should stop cell editing. This
|
|
returns true if F2 is pressed of if {@link Graph#enterStopsCellEditing} is true
|
|
and enter is pressed without control or shift.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>evt: <span class="tsd-signature-type">KeyboardEvent</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="onDestroy" class="tsd-anchor"></a><h3>on<wbr/>Destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">on<wbr/>Destroy<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of GraphPlugin.onDestroy</p><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L1065">view/handler/CellEditorHandler.ts:1065</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Destroys the editor and removes all associated resources.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="prepareTextarea" class="tsd-anchor"></a><h3>prepare<wbr/>Textarea</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">prepare<wbr/>Textarea<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L898">view/handler/CellEditorHandler.ts:898</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Prepares the textarea for getting its value in <stopEditing>.
|
|
This implementation removes the extra trailing linefeed in Firefox.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resize" class="tsd-anchor"></a><h3>resize</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resize<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L487">view/handler/CellEditorHandler.ts:487</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns {@link odified}.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="setAlign" class="tsd-anchor"></a><h3>set<wbr/>Align</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">set<wbr/>Align<span class="tsd-signature-symbol">(</span>align<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L323">view/handler/CellEditorHandler.ts:323</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets the temporary horizontal alignment for the current editing session.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>align: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="startEditing" class="tsd-anchor"></a><h3>start<wbr/>Editing</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">start<wbr/>Editing<span class="tsd-signature-symbol">(</span>cell<span class="tsd-signature-symbol">: </span><a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a>, trigger<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L694">view/handler/CellEditorHandler.ts:694</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Starts the editor for the given cell.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cell: <a href="Cell.html" class="tsd-signature-type" data-tsd-kind="Class">Cell</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p><Cell> to start editing.</p>
|
|
</div></div></li><li><h5>trigger: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MouseEvent</span><span class="tsd-signature-symbol"> = null</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional mouse event that triggered the editor.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stopEditing" class="tsd-anchor"></a><h3>stop<wbr/>Editing</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">stop<wbr/>Editing<span class="tsd-signature-symbol">(</span>cancel<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/maxgraph/maxgraph/blob/598b60e2f/packages/core/src/view/handler/CellEditorHandler.ts#L844">view/handler/CellEditorHandler.ts:844</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>clearSelection() {
|
|
const selection = window.getSelection();</p>
|
|
</div><div><p>if (selection) {
|
|
if (selection.empty) {
|
|
selection.empty();
|
|
} else if (selection.removeAllRanges) {
|
|
selection.removeAllRanges();
|
|
}
|
|
}
|
|
}</p>
|
|
<p>/**
|
|
Stops the editor and applies the value if cancel is false.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>cancel: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/DomHelpers.html">Dom<wbr/>Helpers</a></li><li class=" tsd-kind-namespace"><a href="../modules/cloneUtils.html">clone<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/constants.html">constants</a></li><li class=" tsd-kind-namespace"><a href="../modules/domUtils.html">dom<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/eventUtils.html">event<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/gestureUtils.html">gesture<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/mathUtils.html">math<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/stringUtils.html">string<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/styleUtils.html">style<wbr/>Utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/xmlUtils.html">xml<wbr/>Utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="CellEditorHandler.html" class="tsd-kind-icon">Cell<wbr/>Editor<wbr/>Handler</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="CellEditorHandler.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#align" class="tsd-kind-icon">align</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#autoSize" class="tsd-kind-icon">auto<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#blurEnabled" class="tsd-kind-icon">blur<wbr/>Enabled</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#bounds" class="tsd-kind-icon">bounds</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#changeHandler" class="tsd-kind-icon">change<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#clearOnChange" class="tsd-kind-icon">clear<wbr/>On<wbr/>Change</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#editingCell" class="tsd-kind-icon">editing<wbr/>Cell</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#emptyLabelText" class="tsd-kind-icon">empty<wbr/>Label<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#escapeCancelsEditing" class="tsd-kind-icon">escape<wbr/>Cancels<wbr/>Editing</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#graph" class="tsd-kind-icon">graph</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#initialValue" class="tsd-kind-icon">initial<wbr/>Value</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#minResize" class="tsd-kind-icon">min<wbr/>Resize</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#modified" class="tsd-kind-icon">modified</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#resizeThread" class="tsd-kind-icon">resize<wbr/>Thread</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#selectText" class="tsd-kind-icon">select<wbr/>Text</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textDirection" class="tsd-kind-icon">text<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textNode" class="tsd-kind-icon">text<wbr/>Node</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#textarea" class="tsd-kind-icon">textarea</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#trigger" class="tsd-kind-icon">trigger</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#wordWrapPadding" class="tsd-kind-icon">word<wbr/>Wrap<wbr/>Padding</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#zIndex" class="tsd-kind-icon">z<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="CellEditorHandler.html#zoomHandler" class="tsd-kind-icon">zoom<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="CellEditorHandler.html#pluginId" class="tsd-kind-icon">plugin<wbr/>Id</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#applyValue" class="tsd-kind-icon">apply<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#focusLost" class="tsd-kind-icon">focus<wbr/>Lost</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getBackgroundColor" class="tsd-kind-icon">get<wbr/>Background<wbr/>Color</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getCurrentValue" class="tsd-kind-icon">get<wbr/>Current<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEditingCell" class="tsd-kind-icon">get<wbr/>Editing<wbr/>Cell</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEditorBounds" class="tsd-kind-icon">get<wbr/>Editor<wbr/>Bounds</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getEmptyLabelText" class="tsd-kind-icon">get<wbr/>Empty<wbr/>Label<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getInitialValue" class="tsd-kind-icon">get<wbr/>Initial<wbr/>Value</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#getMinimumSize" class="tsd-kind-icon">get<wbr/>Minimum<wbr/>Size</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#init" class="tsd-kind-icon">init</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#installListeners" class="tsd-kind-icon">install<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isCancelEditingKeyEvent" class="tsd-kind-icon">is<wbr/>Cancel<wbr/>Editing<wbr/>Key<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isEventSource" class="tsd-kind-icon">is<wbr/>Event<wbr/>Source</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isHideLabel" class="tsd-kind-icon">is<wbr/>Hide<wbr/>Label</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isSelectText" class="tsd-kind-icon">is<wbr/>Select<wbr/>Text</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#isStopEditingEvent" class="tsd-kind-icon">is<wbr/>Stop<wbr/>Editing<wbr/>Event</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#onDestroy" class="tsd-kind-icon">on<wbr/>Destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#prepareTextarea" class="tsd-kind-icon">prepare<wbr/>Textarea</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#resize" class="tsd-kind-icon">resize</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#setAlign" class="tsd-kind-icon">set<wbr/>Align</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#startEditing" class="tsd-kind-icon">start<wbr/>Editing</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="CellEditorHandler.html#stopEditing" class="tsd-kind-icon">stop<wbr/>Editing</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |