abbot.script
Class Annotation

java.lang.Object
  extended by abbot.script.Step
      extended by abbot.script.Annotation
All Implemented Interfaces:
XMLConstants, XMLifiable, Serializable

public class Annotation
extends Step

Provides a method for communicating a message on the display. May display for a reasonable delay or require user input to continue.

Usage:

<annotation [userDismiss="true"] >Text or HTML message</annotation>

Properties:
abbot.annotation.min_delay: minimum time to display an annotation
abbot.annotation.delay: per-word time to display an annotation

See Also:
Serialized Form

Nested Class Summary
(package private)  class Annotation.AnnotationWindow
           
(package private)  class Annotation.WindowLock
           
 
Field Summary
static String TAG_ANNOTATION
           
static String TAG_USER_DISMISS
           
 
Fields inherited from interface abbot.script.XMLConstants
TAG_ACTION, TAG_APPLETVIEWER, TAG_ARCHIVE, TAG_ARGS, TAG_ASSERT, TAG_AWT, TAG_AWTTESTSCRIPT, TAG_BORDER_TITLE, TAG_CALL, TAG_CLASS, TAG_CLASSPATH, TAG_CODE, TAG_CODEBASE, TAG_COMMENT, TAG_COMPONENT, TAG_COUNT, TAG_DELEGATE, TAG_DESC, TAG_DOCBASE, TAG_EVENT, TAG_EXPR, TAG_FILENAME, TAG_FIXTURE, TAG_FORKED, TAG_HEIGHT, TAG_HORDER, TAG_ICON, TAG_ID, TAG_INDEX, TAG_INVERT, TAG_INVOKER, TAG_KEYCHAR, TAG_KEYCODE, TAG_KIND, TAG_LABEL, TAG_LAUNCH, TAG_METHOD, TAG_MODIFIERS, TAG_NAME, TAG_PARAMS, TAG_PARENT, TAG_POLL_INTERVAL, TAG_PROPERTY, TAG_ROOT, TAG_SAMPLE, TAG_SCRIPT, TAG_SEQUENCE, TAG_SLOW, TAG_STOP_ON_ERROR, TAG_STOP_ON_FAILURE, TAG_TAG, TAG_TERMINATE, TAG_TEXT, TAG_THREADED, TAG_TIMEOUT, TAG_TITLE, TAG_TRIGGER, TAG_TYPE, TAG_VALUE, TAG_VMARGS, TAG_VORDER, TAG_WAIT, TAG_WEIGHTED, TAG_WIDTH, TAG_WINDOW, TAG_X, TAG_Y
 
Constructor Summary
Annotation(Resolver resolver, Element el, Map attributes)
           
Annotation(Resolver resolver, String description)
           
 
Method Summary
protected  Element addContent(Element el)
          Override if the step actually has some contents.
 Map getAttributes()
          Attributes to save in script.
 String getDefaultDescription()
          Return a reasonable default description for this script step.
 long getDelayTime()
           
 Point getDisplayLocation()
           
 String getRelativeTo()
           
 String getText()
           
 String getTitle()
           
 String getUsage()
          Provide a usage String for this step.
 boolean getUserDismiss()
           
 Window getWindow()
           
 String getXMLTag()
          Define the XML tag to use for this script step.
 boolean isShowing()
           
protected  void runStep()
          Display a non-modal window.
 void setDisplayLocation(Point pt)
           
 void setRelativeTo(String id)
           
 void setText(String text)
           
 void setTitle(String title)
           
 void setUserDismiss(boolean state)
           
 void showAnnotation()
           
 
Methods inherited from class abbot.script.Step
addAttributes, createAttributeMap, createStep, createStep, getDescription, getResolver, parseStepAttributes, resolveClass, resolveTester, run, setDescription, setScriptError, simpleClassName, toEditableString, toString, toXML, toXMLString, usage, usage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TAG_ANNOTATION

public static final String TAG_ANNOTATION
See Also:
Constant Field Values

TAG_USER_DISMISS

public static final String TAG_USER_DISMISS
See Also:
Constant Field Values
Constructor Detail

Annotation

public Annotation(Resolver resolver,
                  Element el,
                  Map attributes)

Annotation

public Annotation(Resolver resolver,
                  String description)
Method Detail

isShowing

public boolean isShowing()

showAnnotation

public void showAnnotation()

getDelayTime

public long getDelayTime()

runStep

protected void runStep()
                throws Throwable
Display a non-modal window.

Specified by:
runStep in class Step
Throws:
Throwable

getWindow

public Window getWindow()

getDefaultDescription

public String getDefaultDescription()
Description copied from class: Step
Return a reasonable default description for this script step. This value is used in the absence of an explicit description.

Specified by:
getDefaultDescription in class Step

getUsage

public String getUsage()
Description copied from class: Step
Provide a usage String for this step.

Specified by:
getUsage in class Step

getXMLTag

public String getXMLTag()
Description copied from class: Step
Define the XML tag to use for this script step.

Specified by:
getXMLTag in class Step

addContent

protected Element addContent(Element el)
Description copied from class: Step
Override if the step actually has some contents. In most cases, it won't.

Overrides:
addContent in class Step

getAttributes

public Map getAttributes()
Description copied from class: Step
Attributes to save in script.

Overrides:
getAttributes in class Step

getUserDismiss

public boolean getUserDismiss()

setUserDismiss

public void setUserDismiss(boolean state)

getRelativeTo

public String getRelativeTo()

setRelativeTo

public void setRelativeTo(String id)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getText

public String getText()

setText

public void setText(String text)

setDisplayLocation

public void setDisplayLocation(Point pt)

getDisplayLocation

public Point getDisplayLocation()


Copyright © 2002-2008 Timothy Wall. All Rights Reserved.
Abbot is hosted on

SourceForge