student.testingsupport

Class GUIFilter.Operator

java.lang.Object

student.testingsupport.GUIFilter.Operator

Direct Known Subclasses:

GUIFilter.BinaryOperator

Enclosing class:

GUIFilter

public abstract static class GUIFilter.Operator
extends Object

This base class represents an operator used to create a query. As the base class for all operators, it defines the primitive query operations supported for all Component objects, each of which can be combined using any operator.

Constructor Summary

Constructors

Constructor and Description
Operator()

Method Summary

Modifier and Type	Method and Description
GUIFilter	ancestorIs(Component ancestor) Create a filter that checks a component's ancestor
protected abstract GUIFilter	applySelfTo(GUIFilter otherFilter) Concrete subclasses must override this to implement an operation on the filter being passed in to transform it into another filter.
GUIFilter	enabledIs(boolean value) Create a filter that succeeds if a component is enabled.
GUIFilter	hasFocusIs(boolean value) Create a filter that succeeds if a component has focus.
GUIFilter	heightIs(int value) Create a filter that checks a component's height.
GUIFilter	isContainedWithin(Rectangle region) Create a filter that checks whether a component's bounding box (as returned by Component.getBounds()) lies within a specific rectangle--that is, whether the entire component's area, rather than just its top left corner, lies within the specified region.
GUIFilter	isLocatedWithin(Rectangle region) Create a filter that checks whether a component's location (its top left corner) lies within a specific rectangle.
GUIFilter	locationIs(int x, int y) Create a filter that checks a component's location relative to its parent.
GUIFilter	nameIs(String name) Create a filter that compares the name of a component against a given value.
GUIFilter	parentIs(Component parent) Create a filter that checks a component's parent
GUIFilter	sizeIs(int width, int height) Create a filter that checks a component's size.
GUIFilter	sizeIsWithin(int maxWidth, int maxHeight) Create a filter that checks a component's size.
GUIFilter	textIs(String text) Create a filter that checks the text of a component by calling the component's getText() method.
GUIFilter	typeIs(Class<? extends Component> aClass) Create a filter that checks the class of a component.
GUIFilter	widthIs(int value) Create a filter that checks a component's width.
GUIFilter	xLocationIs(int x) Create a filter that checks a component's x-coordinate.
GUIFilter	yLocationIs(int y) Create a filter that checks a component's y-coordinate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operator

public Operator()

Method Detail

nameIs

public GUIFilter nameIs(String name)

Create a filter that compares the name of a component against a given value.

Parameters:

name - The name to look for

Returns:

A new filter that succeeds only on components with the given name

textIs

public GUIFilter textIs(String text)

Create a filter that checks the text of a component by calling the component's getText() method.

Parameters:

text - The text to look for

Returns:

A new filter that succeeds only on components where getText() returns the specified text.

hasFocusIs

public GUIFilter hasFocusIs(boolean value)

Create a filter that succeeds if a component has focus.

Parameters:

value - True when searching for a component with focus, or false when searching for one without.

Returns:

A new filter that succeeds only on components that currently has focus

enabledIs

public GUIFilter enabledIs(boolean value)

Create a filter that succeeds if a component is enabled.

Parameters:

value - True when searching for an enabled component, or false when searching for a disabled component.

Returns:

A new filter that succeeds only on components that currently are enabled

typeIs

public GUIFilter typeIs(Class<? extends Component> aClass)

Create a filter that checks the class of a component.

Parameters:

aClass - The required class to check for (any subclass will also match).

Returns:

A new filter that only succeeds on instances of the given class.

widthIs

public GUIFilter widthIs(int value)

Create a filter that checks a component's width.

Parameters:

value - The width to look for.

Returns:

A new filter that succeeds only on components that have the given width.

heightIs

public GUIFilter heightIs(int value)

Create a filter that checks a component's height.

Parameters:

value - The height to look for.

Returns:

A new filter that succeeds only on components that have the given height.

sizeIs

public GUIFilter sizeIs(int width,
                        int height)

Create a filter that checks a component's size.

Parameters:

width - The required width.

height - The required height.

Returns:

A new filter that succeeds only on components that have the given size.

sizeIsWithin

public GUIFilter sizeIsWithin(int maxWidth,
                              int maxHeight)

Create a filter that checks a component's size.

Parameters:

maxWidth - The required width.

maxHeight - The required height.

Returns:

A new filter that succeeds only on components that have the given size.

xLocationIs

public GUIFilter xLocationIs(int x)

Create a filter that checks a component's x-coordinate.

Parameters:

x - The required x-coordinate, relative to the component's parent.

Returns:

A new filter that succeeds only on components that have the given x-coordinate.

yLocationIs

public GUIFilter yLocationIs(int y)

Create a filter that checks a component's y-coordinate.

Parameters:

y - The required y-coordinate, relative to the component's parent.

Returns:

A new filter that succeeds only on components that have the given y-coordinate.

locationIs

public GUIFilter locationIs(int x,
                            int y)

Create a filter that checks a component's location relative to its parent.

Parameters:

x - The required x-coordinate, relative to the component's parent.

y - The required y-coordinate, relative to the component's parent.

Returns:

A new filter that succeeds only on components that have the given location.

isLocatedWithin

public GUIFilter isLocatedWithin(Rectangle region)

Create a filter that checks whether a component's location (its top left corner) lies within a specific rectangle.

Parameters:

region - A rectangle defining a region in the component's parent.

Returns:

A new filter that succeeds only on components that have a location within the given region.

isContainedWithin

public GUIFilter isContainedWithin(Rectangle region)

Create a filter that checks whether a component's bounding box (as returned by Component.getBounds()) lies within a specific rectangle--that is, whether the entire component's area, rather than just its top left corner, lies within the specified region.

Parameters:

region - A rectangle defining a region in the component's parent.

Returns:

A new filter that succeeds only on components that lie entirely within the given region, as determined by Rectangle.contains(Rectangle).

parentIs

public GUIFilter parentIs(Component parent)

Create a filter that checks a component's parent

Parameters:

parent - the parent component of the component being checked

Returns:

A new filter that succeeds only on components that are children of parent

ancestorIs

public GUIFilter ancestorIs(Component ancestor)

Create a filter that checks a component's ancestor

Parameters:

ancestor - one of the ancestors of the component being checked

Returns:

A new filter that succeeds only on components that are descendants of ancestor

applySelfTo

protected abstract GUIFilter applySelfTo(GUIFilter otherFilter)

Concrete subclasses must override this to implement an operation on the filter being passed in to transform it into another filter.

Parameters:

otherFilter - The argument to transform (second argument, for binary operators)

Returns:

A new compound filter that includes the given argument as one subfilter, after applying this operator to it.