Class workspace

Object
   |
   +--workspace

class workspace

A class that represents the workspace. This includes maintaining information about the notes and undo/redo information.
Defined in webnote.js

Field Detail

changed

boolean changed

Have we changed the workspace?

edit

Note edit

The note we are editing.

loadedTime

int loadedTime

The last time that we loaded this workspace (used to check for update collision).

name

string name

The name of the workspace.

nextNoteNum

int nextNoteNum

When creating new notes, we sometimes need to assign a random name to it. The first random note is note0, the second is note1, etc.

notes

dictionary notes

A dictionary of all the notes.

numNotes

int numNotes

Number of notes on the workspace. We keep this as a separate variable since there's no way to determine the size of a dictionary.

shortcuts

boolean shortcuts

Should keyboard shortcuts work?

topId

string topId

The id of the note on top.

workspace

workspace()

_expose

void _expose()

checkUpdated

void checkUpdated()

Checks to see if the notes have changed since the last time we loaded the notes.

createNote

Object createNote(<dictionary> note)

Create a new note. Any of the parameter values may be left blank and default values will be used.

Parameters:
note - a dictionary with any of the following keys: note['id'] = the name of the note
note['xPos'] = the x position of the note
note['yPos'] = the y position of the note
note['height'] = the height of the note
note['width'] = the width of the note
note['bgcolor'] = the background color of the note (hex)
note['zIndex'] = the stacking position of the note
note['text'] = the text value of the note

editOff

void editOff()

If we are editing any note, stop editing.

expose

void expose()

This function acts as an "Expose`" like feature for the notes It sets all of the notes to relative positioning and then grabs the relative location, sets its "top" and "left" properties then resets the positioning to absolute. -sph original patch submitted by Sean Hannan This isn't quite ready for release.

filter

void filter(<string> text)

Filter the visible notes (kind of like a search). Notes that match the regular expression are moved to the front while other notes are disabled and become mostly transparent.

Parameters:
text - the regular expression to filter by

history

void history()

loadlist

void loadlist(<int> offset)

Create the "load old notes" note.

Parameters:
offset - how many saves do we want to go back?

mouse

Object mouse()

mouseUp

void mouseUp()

Mouse up action on the workspace.

notePos

void notePos()

reZOrder

void reZOrder(<string> topNoteID)

Resort the notes and place topNoteID in front.

Parameters:
topNoteID - the name of the note to bring to the front.

save

void save()

Save the workspace.

selectNote

void selectNote(<int> diff)

Get the next (or previous) note relative to the top note.

Parameters:
diff - The offset from the top note (positive mean below and negative mean up from the bottom note).

setName

void setName(<string> n)

Set the name of the workspace. workspace.prototype.NOTE = this;changes where notes get saved.

Parameters:
n - the new name

toString

string toString()

Generate the xml representation of the workspace (used when saving).

updateMiniBox

void updateMiniBox()

Update the background color and tool tips of the mini notes.