| 1 | /*
|
|---|
| 2 | * file: CursorDescriptor.js
|
|---|
| 3 | *
|
|---|
| 4 | * @BEGINLICENSE
|
|---|
| 5 | * Copyright 2010 Brook Novak (email : [email protected])
|
|---|
| 6 | * This program is free software; you can redistribute it and/or modify
|
|---|
| 7 | * it under the terms of the GNU General Public License as published by
|
|---|
| 8 | * the Free Software Foundation; either version 2 of the License, or
|
|---|
| 9 | * (at your option) any later version.
|
|---|
| 10 | * This program is distributed in the hope that it will be useful,
|
|---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 13 | * GNU General Public License for more details.
|
|---|
| 14 | * You should have received a copy of the GNU General Public License
|
|---|
| 15 | * along with this program; if not, write to the Free Software
|
|---|
| 16 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|---|
| 17 | * @ENDLICENSE
|
|---|
| 18 | */
|
|---|
| 19 | /**
|
|---|
| 20 | * @class
|
|---|
| 21 | * <i><b>[INTERFACE]</b></i>
|
|---|
| 22 | *
|
|---|
| 23 | * TODO!!
|
|---|
| 24 | *
|
|---|
| 25 | * @see DirectEdit Specification 1.0
|
|---|
| 26 | *
|
|---|
| 27 | * @author Brook Novak
|
|---|
| 28 | *
|
|---|
| 29 | */
|
|---|
| 30 | de.cursor.CursorDescriptor = function() {
|
|---|
| 31 |
|
|---|
| 32 | /**
|
|---|
| 33 | * A dom node which is either an Element or a Text node. Never null.
|
|---|
| 34 | *
|
|---|
| 35 | * @type Node
|
|---|
| 36 | */
|
|---|
| 37 | this.domNode = null;
|
|---|
| 38 |
|
|---|
| 39 | /**
|
|---|
| 40 | * A bitwise OR of de.cursor.PlacementFlag describing the cursor
|
|---|
| 41 | * relation to the domNode
|
|---|
| 42 | *
|
|---|
| 43 | * @type Number
|
|---|
| 44 | *
|
|---|
| 45 | * @see de.cursor.PlacementFlag
|
|---|
| 46 | */
|
|---|
| 47 | this.placement = 0;
|
|---|
| 48 |
|
|---|
| 49 | /**
|
|---|
| 50 | * The (relative) index of where within the node the cursor is.
|
|---|
| 51 | * <BR><BR>
|
|---|
| 52 | * If the dom node is a text node, then this will be the charactor index.
|
|---|
| 53 | *
|
|---|
| 54 | * @type Number
|
|---|
| 55 | */
|
|---|
| 56 | this.relIndex = 0;
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * The x pixel position relative to the window of the cursor.
|
|---|
| 60 | * @type Number
|
|---|
| 61 | */
|
|---|
| 62 | this.x = 0;
|
|---|
| 63 |
|
|---|
| 64 | /**
|
|---|
| 65 | * The y pixel position relative to the window of the cursor.
|
|---|
| 66 | * @type Number
|
|---|
| 67 | */
|
|---|
| 68 | this.y = 0;
|
|---|
| 69 |
|
|---|
| 70 | /**
|
|---|
| 71 | * The x pixel position relative to the document of the cursor.
|
|---|
| 72 | * @type Number
|
|---|
| 73 | */
|
|---|
| 74 | this.docLeft = 0;
|
|---|
| 75 |
|
|---|
| 76 | /**
|
|---|
| 77 | * The y pixel position relative to the document of the cursor.
|
|---|
| 78 | * @type Number
|
|---|
| 79 | */
|
|---|
| 80 | this.docTop = 0;
|
|---|
| 81 |
|
|---|
| 82 | /**
|
|---|
| 83 | * The pixel width of the cursor's charactor/element.
|
|---|
| 84 | * @type Number
|
|---|
| 85 | */
|
|---|
| 86 | this.width = 0;
|
|---|
| 87 |
|
|---|
| 88 | /**
|
|---|
| 89 | * The pixel height of the cursor's charactor/element.
|
|---|
| 90 | * @type Number
|
|---|
| 91 | */
|
|---|
| 92 | this.height = 0;
|
|---|
| 93 |
|
|---|
| 94 | /**
|
|---|
| 95 | * True to indicate that the cursor is positioned to the right of the dom node/index.
|
|---|
| 96 | * False to indicate that the cursor is positioned to the left of the dom node/index.
|
|---|
| 97 | * @type Boolean
|
|---|
| 98 | */
|
|---|
| 99 | this.isRightOf = false;
|
|---|
| 100 |
|
|---|
| 101 |
|
|---|
| 102 | };
|
|---|
