|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--abbot.script.Step | +--abbot.script.Sequence | +--abbot.script.Script
Provide a structure to encapsulate actions invoked on GUI components and tests performed on those components. Scripts need to be short and concise (and therefore easy to read/write). Extensions don't have to be.
This takes a single filename as a constructor argument.
Use ScriptTestCase and ScriptTestSuite to generate a suite (auto-generate the collection).
Field Summary | |
(package private) static boolean |
validate
|
Fields inherited from interface abbot.script.Tags |
TAG_ACTION, TAG_ARGS, TAG_ASSERT, TAG_AWTTESTSCRIPT, TAG_CALL, TAG_CLASS, TAG_CLASSPATH, TAG_COMMENT, TAG_COMPONENT, TAG_COUNT, TAG_DELEGATE, TAG_DESC, TAG_DOCBASE, TAG_EVENT, TAG_FILENAME, TAG_FORKED, TAG_HEIGHT, TAG_HORDER, TAG_ID, TAG_INDEX, TAG_INVERT, TAG_INVOKER, TAG_KEYCHAR, TAG_KEYCODE, TAG_KIND, TAG_LAUNCH, TAG_METHOD, TAG_MODIFIERS, TAG_NAME, TAG_PARAMS, TAG_PARENT, TAG_POLL_INTERVAL, TAG_PROPERTY, TAG_SAMPLE, TAG_SCRIPT, TAG_SEQUENCE, TAG_SLOW, TAG_STOP_ON_ERROR, TAG_STOP_ON_FAILURE, TAG_TAG, TAG_TERMINATE, TAG_THREADED, TAG_TIMEOUT, TAG_TITLE, TAG_TRIGGER, TAG_TYPE, TAG_VALUE, TAG_VMARGS, TAG_VORDER, TAG_WAIT, TAG_WIDTH, TAG_WINDOW, TAG_X, TAG_Y |
Constructor Summary | |
Script()
Create a new, empty script. |
|
Script(Resolver parent,
Map attributes)
|
|
Script(String filename)
Create a script. |
Method Summary | |
(package private) static void |
|
ComponentReference |
addComponent(Component comp)
Add a new component reference for the given component. |
void |
addComponentReference(ComponentReference ref)
Add a new component reference to the existing collection. |
(package private) ComponentReference |
addComponentReference(org.jdom.Element el)
Add a new component reference to the script. |
org.jdom.Element |
addContent(org.jdom.Element el)
Save component references in addition to everything else. |
void |
addStep(int index,
Step step)
Inserts a step at the given index in the sequence. |
void |
addStep(Step step)
Adds a step to the end of the sequence. |
void |
clear()
Set up a blank script, discarding any current state. |
Map |
getAttributes()
Provide XML attributes for this Step. |
ComponentReference |
getComponentReference(Component comp)
Return the reference for the given component, or null if none yet exists. |
ComponentReference |
getComponentReference(String name)
Convert the given reference ID into a component reference. |
Collection |
getComponentReferences()
Returns a collection of all the existing references. |
protected String |
getDefaultDescription()
Return a reasonable default description for this script step. |
String |
getDescription()
|
File |
getDirectory()
All relative files should be accessed relative to this directory, which is the directory where the script resides. |
File |
getFile()
Return the file where this script is saved. |
String |
getFilename()
Return the (possibly relative) path to this script. |
Launch |
getLaunchStep()
|
String |
getName()
|
String |
getProperty(String name)
Provide retrieval of values from temporary storage. |
File |
getRelativeTo()
By default, all pathnames are relative to the current working directory. |
Step |
getStep(int index)
Return the step at the given index in the sequence. |
String |
getUniqueID(ComponentReference ref)
Return a unique reference ID. |
String |
getUsage()
Returns a string describing the proper XML usage for this class. |
String |
getVMArgs()
|
String |
getXMLTag()
Define the XML tag to use for this script step. |
boolean |
hasLaunch()
|
boolean |
hasTerminate()
|
int |
indexOf(Step step)
Returns the index of the given step in the sequence, or -1 if the step is not in the sequence. |
boolean |
isDirty()
Has this script changed since the last save. |
boolean |
isForked()
|
static boolean |
isScript(File file)
Return whether the given file looks like a valid AWT script. |
boolean |
isSlowPlayback()
|
void |
load()
Parse the script file and build internal structures. |
void |
load(Reader reader)
Loads the XML test script. |
protected void |
parseChild(org.jdom.Element el)
|
void |
removeStep(int index)
Removes the step at the given index in the sequence. |
void |
removeStep(Step step)
Removes the step if it exists in the sequence. |
protected void |
runStep(StepRunner runner)
Process each event in our list, using the given runner. |
void |
save()
Write the script to file. |
void |
save(Writer writer)
Write the current state of the script to file. |
void |
setFile(File file)
Warning: if the directory is changed, need to change associated files as well. |
void |
setForked(boolean fork)
|
void |
setProperty(String name,
String value)
Provide temporary storage of values. |
void |
setRelativeTo(File dir)
Indicate that when invoking toXML, a path relative to the given one should be shown. |
void |
setSlowPlayback(boolean slow)
|
void |
setStep(int index,
Step step)
Replaces the step at the given index. |
void |
setVMArgs(String args)
|
int |
size()
Returns the number of steps contained in this one. |
List |
steps()
Returns a list of the steps contained in this one. |
String |
toEditableString()
Only thing directly editable on a script is its file path. |
String |
toString()
Return a description of this script step. |
Methods inherited from class abbot.script.Sequence |
parseChildren, runStep |
Methods inherited from class abbot.script.Step |
addAttributes, createAttributeMap, createStep, createStep, getFinder, getResolver, parseStepAttributes, resolve, resolveClass, resolveTester, run, setDescription, setScriptError, simpleClassName, toXML, toXMLString, usage, usage |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
static boolean validate
Constructor Detail |
public Script()
public Script(String filename)
public Script(Resolver parent, Map attributes)
Method Detail |
static void()
public String getName()
public void setForked(boolean fork)
public boolean isForked()
public void setVMArgs(String args)
public String getVMArgs()
public boolean isSlowPlayback()
public void setSlowPlayback(boolean slow)
public File getFile()
public void setFile(File file)
public void save(Writer writer) throws IOException
public String toEditableString()
toEditableString
in class Sequence
public boolean isDirty()
public void save() throws IOException
protected void parseChild(org.jdom.Element el) throws InvalidScriptException
parseChild
in class Sequence
public void load(Reader reader) throws InvalidScriptException, IOException
reader
- Provides the script dataInvalidScriptException
- IOException
- public int size()
Sequence
size
in class Sequence
public List steps()
Sequence
steps
in class Sequence
public int indexOf(Step step)
Sequence
indexOf
in class Sequence
public Step getStep(int index)
Sequence
getStep
in class Sequence
public void addStep(int index, Step step)
Sequence
addStep
in class Sequence
public void addStep(Step step)
Sequence
addStep
in class Sequence
public void setStep(int index, Step step)
setStep
in class Sequence
public void removeStep(Step step)
Sequence
removeStep
in class Sequence
public void removeStep(int index)
Sequence
removeStep
in class Sequence
public void load() throws InvalidScriptException, IOException
public String getXMLTag()
Step
getXMLTag
in class Sequence
public org.jdom.Element addContent(org.jdom.Element el)
addContent
in class Sequence
public String getFilename()
public Map getAttributes()
getAttributes
in class Step
protected void runStep(StepRunner runner) throws Throwable
Sequence
runStep
in class Sequence
public String getUniqueID(ComponentReference ref)
getUniqueID
in interface Resolver
public void clear()
clear
in class Sequence
public String getUsage()
Sequence
getUsage
in class Sequence
public String getDescription()
getDescription
in class Step
protected String getDefaultDescription()
Step
getDefaultDescription
in class Sequence
public String toString()
Step
toString
in class Step
public boolean hasLaunch()
public boolean hasTerminate()
public File getRelativeTo()
public void setRelativeTo(File dir)
public static boolean isScript(File file)
public Launch getLaunchStep()
public File getDirectory()
getDirectory
in interface Resolver
public Collection getComponentReferences()
Resolver
getComponentReferences
in interface Resolver
public void addComponentReference(ComponentReference ref)
Resolver
addComponentReference
in interface Resolver
public ComponentReference addComponent(Component comp)
addComponent
in interface Resolver
ComponentReference addComponentReference(org.jdom.Element el) throws InvalidScriptException
public ComponentReference getComponentReference(Component comp)
getComponentReference
in interface Resolver
public ComponentReference getComponentReference(String name)
getComponentReference
in interface Resolver
public void setProperty(String name, String value)
Resolver
setProperty
in interface Resolver
public String getProperty(String name)
Resolver
getProperty
in interface Resolver
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |