previous chapter contents page top page next chapter


Annotation

March 15, 1996

inherits from ContainerWindow;
inherits from InfoTopic;

Class Description

When the user touches a sticky note, the note zooms open to reveal a window filled with the note's contents. This window is a member of class Annotation. In Magic Cap 1.5, the annotation is an object of class ErasableAnnotation, a subclass of Annotation.

Programming information

Instantiate: rarely
Subclass: rarely
Call its methods: never

When the user gets a new sticky note from the stamper, Magic Cap automatically creates the note's associated annotation object, so you probably won't ever create one of your own.

Methods defined by class Annotation

Class Annotation defines the following methods:

Method Description
NotesField Get the text field containing default contents.
AboutToShow Overridden to adjust size of notes field to show all text.
RevealSelection Overridden to enlarge notes field and show selection.
CanAccept Overridden to reject target of self.
CanDrawIn Overridden to always return true.
MaximumScrollOffset Overridden to make sure selection is not behind keyboard.
Disappear Overridden to compress scribbles.
Pressed Overridden to make sure keyboard is in front.
ZoomFromWhere Overridden to return content box of target if onscreen.

Fields defined by class Annotation

Class Annotation defines the following fields:

Field Type Description
Inherited from SingleLinkable
next Object Next item in view list
Inherited from Linkable
previous Object Previous item in view list
Inherited from Viewable
superview Viewable Container for this object
subview Viewable Object contained by this object
relativeOrigin Dot Origin relative to superview
contentSize Dot Size of content rectangle
viewFlags Flags Property settings
labelStyle TextStyle Text style of object's label
color Color Color of object's content
shadow Shadow Shadow drawn with object
sound Sound Sound associated with object
Inherited from HasBorder
border Border Framed border drawn around object
Inherited from Window
windowFlags Flags Stores various boolean attributes of the window
Inherited from TitledWindow
titleColor Unsigned RGB color for title box
titleHeight Micron Height of title box
dependents ObjectList List of dependent windows
Inherited from BalloonSpout
balloonDot Dot Cached dot position, used by Magic Cap
Inherited from GadgetWindow
target Object Target for this window
Inherited from ScrollableByMicron
scrollOffset Current scrolling offset
Inherited from ContainerWindow
gridSize Dot horizontal and vertical grid spacing
gridOffset Dot offset of first grid position
topArrow Viewable scroll up arrow
bottomArrow Viewable scroll down arrow
Inherited from InfoTopic
info Object text or list of viewables for this topic
Defined by Annotation
notesField TextField text field contained by this annotation

Method Descriptions

NotesField

attribute NotesField: TextField, readOnly
// operation NotesField: TextField
Call: rarely
Override: rarely

The attribute NotesField refers to the text field object that contains the text displayed by the sticky note's annotation.

AboutToShow

overrides AboutToShow
Call: rarely
Override: sometimes

Class Annotation overrides AboutToShow to adjust the size of the notes field before the annotation appears. AboutToShow makes the text field at least as tall as the annotation and big enough to fit all the text.

RevealSelection

overrides RevealSelection
Call: rarely
Override: sometimes

Class Annotation overrides RevealSelection to enlarge the notes field and scroll it to show the selection.

CanAccept

overrides CanAccept
Call: rarely
Override: sometimes

Class Annotation overrides CanAccept to reject the target of the responder, preventing the annotation from swallowing itself.

CanDrawIn

overrides CanDrawIn
Call: rarely
Override: sometimes

Class Annotation overrides CanDrawIn to always return true, allowing the user to draw in annotations.

MaximumScrollOffset

overrides MaximumScrollOffset
Call: rarely
Override: sometimes

Class Annotation overrides MaximumScrollOffset to make sure that the text selection is not hidden behind the projected keyboard.

Disappear

overrides Disappear
Call: rarely
Override: sometimes

Class Annotation overrides Disappear to compress scribbles when the annotation is about to disappear.

Pressed

overrides Pressed
Call: rarely
Override: sometimes

Class Annotation overrides Pressed to make sure the projected keyboard is in front of the annotation after the user slides the annotation around on the screen.

ZoomFromWhere

overrides ZoomFromWhere
Call: rarely
Override: sometimes

Class Annotation overrides ZoomFromWhere to return the content box of the target if it is onscreen.