Class Note

Object
   |
   +--Note

class Note

A class that acts as a wrapper to the actual html div that is a note. Rather than operating directly on the html object, use this class instead. TODO: attach these methods directly to the html objects.
Defined in webnote.js

Field Detail

editable

boolean editable

Whether or not we can double click and edit a note

id

string id

The html id of the note

parent

workspace parent

TODO: fix references to workspace with this.parent

selectable

boolean selectable

Whether or not is it possible to click on a note and select it

size

Point size

The height and width of the note

Note

Note(<HtmlElement> note, <workspace> p, <string> text)

Create a new note object. You shouldn't need to call this directly, use workspace.createNote() instead.

Parameters:
note - a reference to the actual note or a string that is the id of the note
p - a reference to the parent workspace
text - the text of the note

destroy

void destroy(<boolean> addToHistory)

Destroy the note (user clicked on the X).

Parameters:
addToHistory - should we add information to the undo stack?

disable

void disable()

Disable a note (can't be moved or edited).

enable

void enable()

Enable a note (can be moved and edited).

getCorrectedSize

Point getCorrectedSize()

Get the size of the note including border and padding.

getHTML

string getHTML()

Convert the text of a note to html. We perform a simple transform of newlines into
and ! into headings. Other wiki/textile like transforms would happen here.

getPosition

Point getPosition()

Get the coordinates of the upper left corner of the note.

getSize

Point getSize()

Get the size of the note according to the dom object (this varies on browser).

keyDown

void keyDown(ev)

Note keyboard events.

miniMouseDown

void miniMouseDown(ev)

User clicked on one of the mini notes at the top of the page.

mouseDblClick

void mouseDblClick()

Double-click event on a note (try to toggle edit mode).

mouseDown

Object mouseDown(ev)

User clicked on a note.

mouseMove

void mouseMove(ev)

Moving the mouse while over a note (changes cursor).

mouseOut

void mouseOut()

Mouse leaves a note (restore original background color).

mouseOver

void mouseOver()

Mouse moves over a note (darken the background color).

mouseUp

void mouseUp()

User deselected a note (stopped dragging).

move

void move(<Point> delta)

Move the note relative to its current position.

Parameters:
delta - a point object

select

void select()

When a note is selected from the mini note toolbar, we bring it to the front and flash the background.

sendToBack

void sendToBack()

Send a note to the back of the workspace.

setColor

void setColor(<string> hex, <boolean> ignoreHistory)

Set the color of a note.

Parameters:
hex - the color in hex
ignoreHistory - should we add it to the history? Different default values makes this inconsistent with destroy()

setText

void setText(<string> str)

Change the text of a note.

Parameters:
str - the text for the note.

toXML

string toXML()

Generate the xml representing a note (used when we save notes).

updateSize

void updateSize()

We keep track of the size of the note internally; this method updates that value.