Multivalent API

multivalent.std.span
Class LabelSpan

java.lang.Object
  extended by multivalent.VObject
      extended by multivalent.Behavior
          extended by multivalent.Span
              extended by multivalent.std.span.LabelSpan
All Implemented Interfaces:
ContextListener, EventListener, java.util.EventListener

public class LabelSpan
extends Span

Helper span for copy editor marks that draws message above content text.

Version:
$Revision: 1.2 $ $Date: 2002/02/02 13:16:27 $

Field Summary
 
Fields inherited from class multivalent.Span
GI_END, GI_START, MSG_DELETE, MSG_EDIT, MSG_MORPH, MSG_UNATTACHED, pend, pstart
 
Fields inherited from class multivalent.Behavior
ATTR_BEHAVIOR, name_
 
Fields inherited from class multivalent.VObject
attr_
 
Fields inherited from interface multivalent.ContextListener
LITTLE, LOT, PRIORITY_LENS, PRIORITY_MAX, PRIORITY_MIN, PRIORITY_SELECTION, PRIORITY_SPAN, PRIORITY_STRUCT, SOME
 
Constructor Summary
LabelSpan()
           
 
Method Summary
 boolean appearance(Context cx, boolean all)
          Resets the graphics context every time the object is added to or dropped from the set active over the portion of the document being drawn.
 int getPriority()
          Self-reported priority relative to others of the same class, e.g., other spans.
 void moveq(Leaf ln, int lo, Leaf rn, int ro)
          "move quick" just updates summaries, so more efficient than move(), if caller: guarantees that first node comes before second node (so the system doesn't have to spend time checking this), and handles all reformatting and repainting (including marking tree nodes dirty) Useful using during initial tree builds, when adding spans and formatting in batch(es).
 boolean paintBefore(Context cx, Node start)
          A tree walk protocol, called before observed node has been painted.
 boolean semanticEventAfter(SemanticEvent se, java.lang.String msg)
          Intert to events.
 boolean semanticEventBefore(SemanticEvent se, java.lang.String msg)
          Intert to events (so don't get double entries in popups).
 void setLabel(java.lang.String label)
           
 
Methods inherited from class multivalent.Span
buildAfter, checkRep, close, closeAll, contains, contains, destroy, event, getEnd, getStart, isSet, markDirty, move, move, move, moveq, moveq, moveqSwap, open, repaint, repaint, restore, save, stretch, toString
 
Methods inherited from class multivalent.Behavior
buildBefore, clipboardAfter, clipboardBefore, createUI, eventAfter, eventBefore, formatAfter, formatBefore, getBrowser, getDocument, getInstance, getInstance, getLayer, getLogger, getName, getPreference, getRoot, isEditable, paintAfter, putPreference, redo, restoreChildren, setName, undo
 
Methods inherited from class multivalent.VObject
attrEntrySetIterator, attrKeysIterator, clearAttributes, getAttr, getAttr, getAttributes, getGlobal, getValue, hasAttributes, putAttr, removeAttr, setAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LabelSpan

public LabelSpan()
Method Detail

setLabel

public void setLabel(java.lang.String label)

paintBefore

public boolean paintBefore(Context cx,
                           Node start)
Description copied from class: Behavior
A tree walk protocol, called before observed node has been painted. Called in same coordinate space as node's painting. Can be used draw special background, but usual background setting is done by spans or style sheets.

Overrides:
paintBefore in class Behavior
Returns:
true to short-circuit to paintAfter at that node, bypassing painting of the subtree.

getPriority

public int getPriority()
Description copied from interface: ContextListener
Self-reported priority relative to others of the same class, e.g., other spans. Use the constants defined here, such as ContextListener.PRIORITY_LENS, modified by ContextListener.LITTLE/ContextListener.SOME/{#link LOT}.

Specified by:
getPriority in interface ContextListener
Overrides:
getPriority in class Span

moveq

public void moveq(Leaf ln,
                  int lo,
                  Leaf rn,
                  int ro)
Description copied from class: Span
"move quick" just updates summaries, so more efficient than move(), if caller:
  1. guarantees that first node comes before second node (so the system doesn't have to spend time checking this), and
  2. handles all reformatting and repainting (including marking tree nodes dirty)
Useful using during initial tree builds, when adding spans and formatting in batch(es). Checks that endpoint offsets are valid, that is, >=0 and
Overrides:
moveq in class Span

appearance

public boolean appearance(Context cx,
                          boolean all)
Description copied from interface: ContextListener
Resets the graphics context every time the object is added to or dropped from the set active over the portion of the document being drawn. These behaviors can come from the style sheet, be ad hoc spans, be lenses, or come from elsewhere. Should be fast.

Specified by:
appearance in interface ContextListener
Overrides:
appearance in class Span
all - all attributes or exclude those that are not inherited

semanticEventBefore

public boolean semanticEventBefore(SemanticEvent se,
                                   java.lang.String msg)
Intert to events (so don't get double entries in popups).

Overrides:
semanticEventBefore in class Span

semanticEventAfter

public boolean semanticEventAfter(SemanticEvent se,
                                  java.lang.String msg)
Intert to events.

Overrides:
semanticEventAfter in class Span

Multivalent API