A tool to create text fields on a canvas.
Extends stencil.Text by adding an HTML layer that can be dragged out to a certain size, and accept a text entry. Will wrap text to the width of the html field. When created programmtically, use 'auto' to shrink the width to the size of the text. Use line breaks ( \n ) to create new lines.
| Parameter | Type | Description |
|---|---|---|
| options | undefined |
The height of each line of text. Based on style information and font size.
The minimum size allowed for a render. If the size is less, the shape is destroyed.
Whether the Stencil is selected when the text field is executed or not
If true and there is no text in the data, the TextBlock Is displayed and focused and awaits input.
Text vertical alignment Options: top, middle, bottom (FIXME: bottom not supported)
Create the hit and highlight area for the Text.
Internal. Sets the rawNode attribute. (Or in Silverlight an "object attribute". "stencil" is used by the application to determine if something is selectable or not. This also sets the mouse custom events like: "onStencilUp". To disable the selectability, make the att "", which causes a standard mouse event. Labels are special and used to select master stencils.
| Parameter | Type | Description |
|---|---|---|
| shape | undefined |
| Parameter | Type | Description |
|---|---|---|
| options | undefined | |
| create | undefined |
Applies the transform to the stencil
NOTE: PARTIALLY IMPLEMENTED. Only applies x y coords.
| Parameter | Type | Description |
|---|---|---|
| mx | undefined |
Changes properties in the style or disabled styles, depending on whether the object is enabled. Also can be used to change most position and size props.
| Parameter | Type | Description |
|---|---|---|
| key | String | Object | |
| value | String | Number |
Optional
|
Cleans text. Strings HTML chars and double spaces and optionally removes line breaks.
| Parameter | Type | Description |
|---|---|---|
| txt | String | |
| removeBreaks | Boolean |
Convenience method for quick connects See comments below for possiblities functions can be strings
| Parameter | Type | Description |
|---|---|---|
| o | undefined | |
| e | undefined | |
| s | undefined | |
| m | undefined | |
| once | Boolean | If true, the connection happens only once then disconnects. Five args are required for this functionality. |
Internal. Registers this Stencil to receive mouse events.
Convenience method for batches of quick connects Handles are not returned and therefore cannot be disconnected until Shape destroy time
Internal. Creates the connections to the contenteditable HTML node.
Internal. Creates HTML nodes at each corner of the contenteditable div. These nodes are draggable and will resize the div horizontally.
Internal. Inserts the contenteditable HTML node into its parent node, and styles it.
| Parameter | Type | Description |
|---|---|---|
| txt | String |
Converts data to points.
| Parameter | Type | Description |
|---|---|---|
| o | Object |
Called when the Stencil is deselected. NOTE: Calling this will not deselect the Stencil calling this just sets the style to the current theme. 'manager.Stencil' should be used for selecting and deselecting Stencils.
| Parameter | Type | Description |
|---|---|---|
| useDelay | Boolean | Adds slight delay before the style is set. |
Disables Stencil so it is not selectable. Changes the color to the disabled style.
Removes connections based on passed handles arguments
| Parameter | Type | Description |
|---|---|---|
| handles | Handle | Array |
Internal. Unregisters this Stencil from receiving mouse events.
Internal? Method used to instantiate the contenteditable HTML node.
Enables Stencil so it is not selectable (if it was selectable to begin with). Changes the color to the current style.
Internal. Method fired when text is executed, via mouse-click-off, ESC key or Enter key.
Gets angle of Stencil NOTE: Only works for Lines, Arrows, Vectors and Axes (works on points, not transforms)
Returns the coordinates of the Stencil. This is often different than the data or the points.
NOTE: Won't work for paths or annotations (labels, Axes, arrow tips) They should overwrite.
NOTE: Primarily used for checking for if shape is off canvas. Therefore Lines could get flipped. Use absolute to prevent this.
| Parameter | Type | Description |
|---|---|---|
| absolute | Boolean | Keeps lines from flipping (see note). |
Gets radius (length) of Stencil.
NOTE: Only works for Lines, Arrows and Vectors (not for Ellipse, Axes has its own version)
This gets and stores the caret position in the contentEditable div (conEdit). NOTE: Doesn't work with html nodes inside the div.
| Parameter | Type | Description |
|---|---|---|
| node | undefined |
Returns the current transform (position) of the Stencil's container
Uses saved caret position to insert text into position and place caret at the end of insertion
| Parameter | Type | Description |
|---|---|---|
| node | undefined | |
| val | undefined |
| Parameter | Type | Description |
|---|---|---|
| text | undefined | |
| w | undefined |
Mechanism for measuring text. SVG nor VML have a way of determining the width or height of a block of text. This method creates an HTML text block and those measurements are used for displaying the SVG/VML text.
| Parameter | Type | Description |
|---|---|---|
| str | String | The text to display and measure. |
| width | Number | If the width is not provided, it will be assumed that the text is one line and the width will be measured and the _lineHeight used for th height. If width is provided, word-wrap is assumed, and line breaks will be inserted into the text at each point where a word wraps in the HTML. The height is then measured. |
Moves Stencil to the back of all other items on the canvas.
Moves Stencil to the front of all other items on the canvas.
Converts points to data
| Parameter | Type | Description |
|---|---|---|
| p | Array |
Internal. Prevent item from being drawn/rendered less than zero on the X or Y.
Removes shape(s), typically before a re-render No args defaults to this.shape Pass in multiple args to remove multiple shapes
Renders the 'hit' object (the shape used for an expanded hit area and for highlighting) and the'shape' (the actual display object). Text is slightly different than other implementations. Instead of calling render twice, it calls _createHilite for the 'hit'
| Parameter | Type | Description |
|---|---|---|
| text | String | Changes text if sent. Be sure to use the setText and not to call this directly. |
Called when the Stencil is selected. NOTE: Calling this will not select the Stencil calling this just sets the style to the 'selected' theme. 'manager.Stencil' should be used for selecting Stencils.
Setter for Stencil data; also converts data to points. See individual Stencils for specific data properties.
| Parameter | Type | Description |
|---|---|---|
| data | StencilData |
Creates and sets a label annotation for the Stencil. If Stencil contains a labelPosition method, that will be used for positioning. Otherwise dojox.drawing.util.positioning.label is used.
| Parameter | Type | Description |
|---|---|---|
| text | String | The text to set as the label. |
Setter for Stencil points; also converts points to data. See individual Stencils for specific points properties.
| Parameter | Type | Description |
|---|---|---|
| points | StencilPoints |
Internal, called when caret needs to be moved into position after text is added
| Parameter | Type | Description |
|---|---|---|
| val | undefined |
Used for placing the cursor during edits and character help. Takes the values: end, beg, start, all or any numerical value (in which case the number will constitute the caret position)
| Parameter | Type | Description |
|---|---|---|
| node | undefined | |
| what | undefined |
Sets the transform to the stencil
NOTE: PARTIALLY IMPLEMENTED. Only applies x y coords.
| Parameter | Type | Description |
|---|---|---|
| mx | Object |
Internal. Builds the parent node for the contenteditable HTML node.
| Parameter | Type | Description |
|---|---|---|
| obj | EventObject |
Moves object to a new X Y location mx is additive. So mx.dx=1 will move the stencil 1 pixel to the right from wherever it was.
| Parameter | Type | Description |
|---|---|---|
| mx | undefined |
Register raw text, returning typeset form. Uses function dojox.drawing.stencil.Text.typeset for typesetting, if it exists.
| Parameter | Type | Description |
|---|---|---|
| text | undefined |
Drag-create or programmatic create calls onRender and afterwards, _onPostRender is called and manages further events.
| Parameter | Type | Description |
|---|---|---|
| data | Object |
Stub - Fires before render occurs.
| Parameter | Type | Description |
|---|---|---|
| stencil | Object |
Stub - fires on change of dimensional properties or a text change
| Parameter | Type | Description |
|---|---|---|
| stencil | Object |
Fires when styles of shape has changed
| Parameter | Type | Description |
|---|---|---|
| stencil | Object |
| Parameter | Type | Description |
|---|---|---|
| value | undefined |
Stub - fires before this is destroyed
| Parameter | Type | Description |
|---|---|---|
| stencil | Stencil |
Stub - fires on change of any property, including style properties
| Parameter | Type | Description |
|---|---|---|
| stencil | Object |
Mouse event, fired on mousemove while mouse is not down. NOTE: Not currently implemented
| Parameter | Type | Description |
|---|---|---|
| obj | EventObject |
Stub - Fires on creation. Drawing connects to this (once!) to be notified of drag completion. But only if it was registered as a Tool. Creating Stencil in and of itself does not register it.
This should fire at the end of creation (not during drag)
| Parameter | Type | Description |
|---|---|---|
| stencil | Object |
Called from anchor point mouse drag also called from plugins.Pan.checkBounds
| Parameter | Type | Description |
|---|---|---|
| anchor | ? manager.Anchor |
Fired at the start of a transform. This would be an anchor drag or a selection.
| Parameter | Type | Description |
|---|---|---|
| anchor | ? manager.Anchor |
Called from anchor point up mouse up
| Parameter | Type | Description |
|---|---|---|
| anchor | manager.Anchor |