Class PassFailJFrame.Builder

java.lang.Object

PassFailJFrame.Builder

Enclosing class:

PassFailJFrame

public static final class PassFailJFrame.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PassFailJFrame	build()
PassFailJFrame.Builder	columns(int columns)	Sets the number of columns for displaying the instruction text.
PassFailJFrame.Builder	instructions(String instructions)
PassFailJFrame.Builder	logArea()	Adds a log area below the "Pass", "Fail" buttons.
PassFailJFrame.Builder	logArea(int rows)	Adds a log area below the "Pass", "Fail" buttons.
PassFailJFrame.Builder	position(PassFailJFrame.Position position)
PassFailJFrame.Builder	positionTestUI(PassFailJFrame.PositionWindows positionWindows)	Adds an implementation of PositionWindows which the framework will use to position multiple test UI windows.
PassFailJFrame.Builder	positionTestUIBottomColumn()	Positions the test UI windows in a column to the bottom of the instruction frame.
PassFailJFrame.Builder	positionTestUIBottomRow()	Positions the test UI windows in a row to the bottom of the instruction frame.
PassFailJFrame.Builder	positionTestUIBottomRowCentered()	Positions the test UI windows in a row to the bottom of the instruction frame centering the row of the windows.
PassFailJFrame.Builder	positionTestUIRightColumn()	Positions the test UI windows in a column to the right of the instruction frame.
PassFailJFrame.Builder	positionTestUIRightColumnCentered()	Positions the test UI windows in a column to the right of the instruction frame centering the stack of the windows.
PassFailJFrame.Builder	positionTestUIRightRow()	Positions the test UI windows in a row to the right of the instruction frame.
PassFailJFrame.Builder	rows(int rows)	Sets the number of rows for displaying the instruction text.
PassFailJFrame.Builder	rowsAdd(int rowsAdd)	Adds a certain number of rows for displaying the instruction text.
PassFailJFrame.Builder	screenCapture()
PassFailJFrame.Builder	splitUI(PassFailJFrame.PanelCreator panelCreator)	Adds a PanelCreator which the framework will use to create a component with test UI and display it in a split pane.
PassFailJFrame.Builder	splitUIBottom(PassFailJFrame.PanelCreator panelCreator)	Adds a PanelCreator which the framework will use to create a component with test UI and display it in the bottom of instruction UI.
PassFailJFrame.Builder	splitUIRight(PassFailJFrame.PanelCreator panelCreator)	Adds a PanelCreator which the framework will use to create a component with test UI and display it to the right of instruction UI.
PassFailJFrame.Builder	testTimeOut(long testTimeOut)
PassFailJFrame.Builder	testUI(Window window)	Adds an already created test UI window.
PassFailJFrame.Builder	testUI(Window... windows)	Adds an array of already created test UI windows.
PassFailJFrame.Builder	testUI(List<? extends Window> windows)	Adds a list of already created test UI windows.
PassFailJFrame.Builder	testUI(PassFailJFrame.PanelCreator panelCreator)	Adds a PanelCreator which the framework will use to create a component and place it into a dialog.
PassFailJFrame.Builder	testUI(PassFailJFrame.WindowCreator windowCreator)	Adds a WindowCreator which the framework will use to create the test UI window.
PassFailJFrame.Builder	testUI(PassFailJFrame.WindowListCreator windowListCreator)	Adds a WindowListCreator which the framework will use to create a list of test UI windows.
PassFailJFrame.Builder	title(String title)

Methods inherited from class java.lang.Object

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

Method Details

title

public PassFailJFrame.Builder title(String title)

instructions

public PassFailJFrame.Builder instructions(String instructions)

testTimeOut

public PassFailJFrame.Builder testTimeOut(long testTimeOut)

rows

public PassFailJFrame.Builder rows(int rows)

Sets the number of rows for displaying the instruction text. The default value is the number of lines in the text plus 1: ((int) instructions.lines().count() + 1).

Parameters:

rows - the number of rows for instruction text

Returns:

this builder

rowsAdd

public PassFailJFrame.Builder rowsAdd(int rowsAdd)

Adds a certain number of rows for displaying the instruction text.

Parameters:

rowsAdd - the number of rows to add to the number of rows

Returns:

this builder

See Also:

• rows

columns

public PassFailJFrame.Builder columns(int columns)

Sets the number of columns for displaying the instruction text.

Parameters:

columns - the number of columns for instruction text

Returns:

this builder

screenCapture

public PassFailJFrame.Builder screenCapture()

logArea

public PassFailJFrame.Builder logArea()

Adds a log area below the "Pass", "Fail" buttons.

The log area can be controlled by PassFailJFrame.log(String), PassFailJFrame.logClear() and PassFailJFrame.logSet(String).

Returns:

this builder

logArea

public PassFailJFrame.Builder logArea(int rows)

Adds a log area below the "Pass", "Fail" buttons.

The log area can be controlled by PassFailJFrame.log(String), PassFailJFrame.logClear() and PassFailJFrame.logSet(String).

The number of columns is taken from the number of columns in the instructional JTextArea.

Parameters:

rows - of the log area

Returns:

this builder

testUI

public PassFailJFrame.Builder testUI(PassFailJFrame.WindowCreator windowCreator)

Adds a WindowCreator which the framework will use to create the test UI window.

Parameters:

windowCreator - a WindowCreator to create the test UI window

Returns:

this builder

Throws:

IllegalArgumentException - if windowCreator is null

IllegalStateException - if a window creator or a list of test windows is already set

positionTestUI

public PassFailJFrame.Builder positionTestUI(PassFailJFrame.PositionWindows positionWindows)

Adds an implementation of PositionWindows which the framework will use to position multiple test UI windows.

Parameters:

positionWindows - an implementation of PositionWindows to position multiple test UI windows

Returns:

this builder

Throws:

IllegalArgumentException - if the positionWindows parameter is null

IllegalStateException - if the positionWindows field is already set

positionTestUIRightRow

public PassFailJFrame.Builder positionTestUIRightRow()

Positions the test UI windows in a row to the right of the instruction frame. The top of the windows is aligned to that of the instruction frame.

Returns:

this builder

positionTestUIRightColumn

public PassFailJFrame.Builder positionTestUIRightColumn()

Positions the test UI windows in a column to the right of the instruction frame. The top of the first window is aligned to that of the instruction frame.

Returns:

this builder

positionTestUIRightColumnCentered

public PassFailJFrame.Builder positionTestUIRightColumnCentered()

Positions the test UI windows in a column to the right of the instruction frame centering the stack of the windows.

Returns:

this builder

positionTestUIBottomRow

public PassFailJFrame.Builder positionTestUIBottomRow()

Positions the test UI windows in a row to the bottom of the instruction frame. The left of the first window is aligned to that of the instruction frame.

Returns:

this builder

positionTestUIBottomRowCentered

public PassFailJFrame.Builder positionTestUIBottomRowCentered()

Positions the test UI windows in a row to the bottom of the instruction frame centering the row of the windows.

Returns:

this builder

positionTestUIBottomColumn

public PassFailJFrame.Builder positionTestUIBottomColumn()

Positions the test UI windows in a column to the bottom of the instruction frame. The left of the first window is aligned to that of the instruction frame.

Returns:

this builder

testUI

public PassFailJFrame.Builder testUI(PassFailJFrame.WindowListCreator windowListCreator)

Adds a WindowListCreator which the framework will use to create a list of test UI windows.

Parameters:

windowListCreator - a WindowListCreator to create test UI windows

Returns:

this builder

Throws:

IllegalArgumentException - if windowListCreator is null

IllegalStateException - if a window creator or a list of test windows is already set

testUI

public PassFailJFrame.Builder testUI(Window window)

Adds an already created test UI window. The window is positioned and shown automatically.

Parameters:

window - a test UI window

Returns:

this builder

testUI

public PassFailJFrame.Builder testUI(Window... windows)

Adds an array of already created test UI windows.

Parameters:

windows - an array of test UI windows

Returns:

this builder

testUI

public PassFailJFrame.Builder testUI(List<? extends Window> windows)

Adds a list of already created test UI windows.

Parameters:

windows - a list of test UI windows

Returns:

this builder

Throws:

IllegalArgumentException - if windows is null or the list contains null

IllegalStateException - if a window creator or a list of test windows is already set

testUI

public PassFailJFrame.Builder testUI(PassFailJFrame.PanelCreator panelCreator)

Adds a PanelCreator which the framework will use to create a component and place it into a dialog.

Parameters:

panelCreator - a PanelCreator to create a component with test UI

Returns:

this builder

Throws:

IllegalStateException - if split UI was enabled using a splitUI method

splitUI

public PassFailJFrame.Builder splitUI(PassFailJFrame.PanelCreator panelCreator)

Adds a PanelCreator which the framework will use to create a component with test UI and display it in a split pane.

By default, horizontal orientation is used, and test UI is displayed to the right of the instruction UI.

Parameters:

panelCreator - a PanelCreator to create a component with test UI

Returns:

this builder

Throws:

IllegalStateException - if a PanelCreator is already set

IllegalArgumentException - if panelCreator is null

splitUIRight

public PassFailJFrame.Builder splitUIRight(PassFailJFrame.PanelCreator panelCreator)

Adds a PanelCreator which the framework will use to create a component with test UI and display it to the right of instruction UI.

Parameters:

panelCreator - a PanelCreator to create a component with test UI

Returns:

this builder

Throws:

IllegalStateException - if a PanelCreator is already set

IllegalArgumentException - if panelCreator is null

splitUIBottom

public PassFailJFrame.Builder splitUIBottom(PassFailJFrame.PanelCreator panelCreator)

Adds a PanelCreator which the framework will use to create a component with test UI and display it in the bottom of instruction UI.

Parameters:

panelCreator - a PanelCreator to create a component with test UI

Returns:

this builder

Throws:

IllegalStateException - if a PanelCreator is already set

IllegalArgumentException - if panelCreator is null

position

public PassFailJFrame.Builder position(PassFailJFrame.Position position)

build

public PassFailJFrame build()
                     throws InterruptedException,
InvocationTargetException

Throws:

InterruptedException

InvocationTargetException