API/libsapojs/SAPO/Component/Imagenote

[Elements] are optional

Class SAPO.Component.Imagenote


class SAPO.Component.Imagenote
Defined in Component/Imagenote/0.1/lib.js

Constructor Summary
Imagenote (elementID targetElementId, [Boolean init])
Imagenote (DOMElement targetElement, [Boolean init])
Imagenote (Object options, [Boolean init])
Renders a note field over an image. The note has an area which size can be changed by the user, and a field where the user can write the note.
Every selector gets a class name SAPO_Component_Imagenote and you can also specify another class for each selector field and for the message fields (editable and non editable).

Constructor Details

constructor Imagenote

Imagenote(elementID targetElementId, [Boolean init])
Imagenote(DOMElement targetElement, [Boolean init])
Imagenote(Object options, [Boolean init])
Renders a note field over an image. The note has an area which size can be changed by the user, and a field where the user can write the note.
Every selector gets a class name SAPO_Component_Imagenote and you can also specify another class for each selector field and for the message fields (editable and non editable).
Parameters:
Element object
targetElementId - render the dialog on this element
[init] - set this parameter to true if you're creating a note programatically, otherwise the note will start in edition mode
Element id
targetElement - render the dialog on this element
[init] - set this parameter to true if you're creating a note programatically, otherwise the note will start in edition mode
Options object
options Options for the new note
  • elementID|DOMElement targetElementId|targetElement - render the note on this element
  • [ String defaultMessage ] - default text for the note field
  • [ Number width ] - note width
  • [ Number height ] - note height
  • [ Number left ] - left position
  • [ Number top ] - top position
  • [ String saveLabel ] - label for the save button
  • [ String cancelLabel ] - label for the cancel button
  • [ String deleteLabel ] - label for the delete button
  • [ String noteClass ] - class name which should be applied to the note field being created
  • [ String editableClass ] - class name which should be applied to the editable note field
  • [ String publicClass ] - class name which should be applied to the note field the other users will see
  • [ Boolean editable ] - if the note is editable after it's creation, double clicking on it
  • [ Function saveCallback ] - callback called when note is saved. Receives the following parameters: top position, left position, width, height, message, and "this" is the form DOM object
  • [ Function deleteCallback ] - callback called when note is deleted. Receives the message object as a parameter and "this" is the note object
[init] - set this parameter to true if you're creating a note programatically, otherwise the note will start in edition mode