org.assertj.swing.fixture

Class JTextComponentFixture

java.lang.Object

org.assertj.swing.fixture.AbstractComponentFixture<S,T,D>

org.assertj.swing.fixture.AbstractJComponentFixture<S,T,D>

org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture<JTextComponentFixture,JTextComponent,JTextComponentDriver>

org.assertj.swing.fixture.JTextComponentFixture

All Implemented Interfaces:

EditableComponentFixture<JTextComponentFixture>, JComponentFixture<JTextComponentFixture>, JPopupMenuInvokerFixture, MouseInputSimulationFixture<JTextComponentFixture>, TextDisplayFixture<JTextComponentFixture>, TextInputFixture<JTextComponentFixture>

public class JTextComponentFixture
extends AbstractJPopupMenuInvokerFixture<JTextComponentFixture,JTextComponent,JTextComponentDriver>
implements TextInputFixture<JTextComponentFixture>

Supports functional testing of JTextComponents.

Author:

Alex Ruiz

Field Summary

Fields inherited from class org.assertj.swing.fixture.AbstractComponentFixture

BACKGROUND_PROPERTY, FONT_PROPERTY, FOREGROUND_PROPERTY

Constructor Summary

Constructors

Constructor and Description
JTextComponentFixture(Robot robot, JTextComponent target) Creates a new JTextComponentFixture.
JTextComponentFixture(Robot robot, String textComponentName) Creates a new JTextComponentFixture.

Method Summary

Methods

Modifier and Type	Method and Description
protected JTextComponentDriver	createDriver(Robot robot)
JTextComponentFixture	deleteText() Simulates a user deleting all the text in this fixture's JTextComponent.
JTextComponentFixture	enterText(String text) Simulates a user entering the given text in this fixture's JTextComponent.
JTextComponentFixture	requireEditable() Asserts that this fixture's JTextComponent is editable.
JTextComponentFixture	requireEmpty() Asserts that the target text component does not contain any text.
JTextComponentFixture	requireNotEditable() Asserts that this fixture's JTextComponent is not editable.
JTextComponentFixture	requireText(Pattern pattern) Asserts that the text of this fixture's JTextComponent matches the given regular expression pattern.
JTextComponentFixture	requireText(String expected) Asserts that the text of this fixture's JTextComponent is equal to the specified value.
JTextComponentFixture	select(String text) Simulates a user selecting the given text contained in this fixture's JTextComponent.
JTextComponentFixture	selectAll() Simulates a user selecting all the text contained in this fixture's JTextComponent.
JTextComponentFixture	selectText(int start, int end) Simulates a user selecting a portion of the text contained in this fixture's JTextComponent.
JTextComponentFixture	setText(String text) Sets the text in this fixture's JTextComponent.
String	text()

Methods inherited from class org.assertj.swing.fixture.AbstractJPopupMenuInvokerFixture

showPopupMenu, showPopupMenuAt

Methods inherited from class org.assertj.swing.fixture.AbstractJComponentFixture

clientProperty, requireToolTip, requireToolTip

Methods inherited from class org.assertj.swing.fixture.AbstractComponentFixture

background, click, click, click, doubleClick, driver, focus, font, foreground, isEnabled, myself, pressAndReleaseKey, pressAndReleaseKeys, pressKey, releaseKey, replaceDriverWith, requireDisabled, requireEnabled, requireEnabled, requireFocused, requireNotVisible, requireShowing, requireVisible, rightClick, robot, target, targetCastedTo

Methods inherited from class java.lang.Object

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

Constructor Detail

JTextComponentFixture

public JTextComponentFixture(@Nonnull
                     Robot robot,
                     @Nonnull
                     JTextComponent target)

Creates a new JTextComponentFixture.

Parameters:

robot - performs simulation of user events on the given JTextComponent.

target - the JTextComponent to be managed by this fixture.

Throws:

NullPointerException - if robot is null.

NullPointerException - if target is null.

JTextComponentFixture

public JTextComponentFixture(@Nonnull
                     Robot robot,
                     @Nullable
                     String textComponentName)

Creates a new JTextComponentFixture.

Parameters:

robot - performs simulation of user events on a JTextComponent.

textComponentName - the name of the JTextComponent to find using the given Robot.

Throws:

NullPointerException - if robot is null.

ComponentLookupException - if a matching JTextComponent could not be found.

ComponentLookupException - if more than one matching JTextComponent is found.

Method Detail

createDriver

@Nonnull
protected JTextComponentDriver createDriver(@Nonnull
                                        Robot robot)

Specified by:

createDriver in class AbstractComponentFixture<JTextComponentFixture,JTextComponent,JTextComponentDriver>

text

@Nullable
public String text()

Specified by:

text in interface TextDisplayFixture<JTextComponentFixture>

Returns:

the text of this fixture's JTextComponent.

select

@Nonnull
public JTextComponentFixture select(@Nonnull
                                   String text)

Simulates a user selecting the given text contained in this fixture's JTextComponent.

Specified by:

select in interface TextInputFixture<JTextComponentFixture>

Parameters:

text - the text to select.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

IllegalArgumentException - if this fixture's JTextComponent does not contain the given text to select.

ActionFailedException - if the selecting the text in the given range fails.

selectText

@Nonnull
public JTextComponentFixture selectText(int start,
                                       int end)

Simulates a user selecting a portion of the text contained in this fixture's JTextComponent.

Specified by:

selectText in interface TextInputFixture<JTextComponentFixture>

Parameters:

start - index where selection should start.

end - index where selection should end.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

ActionFailedException - if the selecting the text in the given range fails.

selectAll

@Nonnull
public JTextComponentFixture selectAll()

Simulates a user selecting all the text contained in this fixture's JTextComponent.

Specified by:

selectAll in interface TextInputFixture<JTextComponentFixture>

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

deleteText

@Nonnull
public JTextComponentFixture deleteText()

Simulates a user deleting all the text in this fixture's JTextComponent.

Specified by:

deleteText in interface TextInputFixture<JTextComponentFixture>

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

enterText

@Nonnull
public JTextComponentFixture enterText(@Nonnull
                                      String text)

Simulates a user entering the given text in this fixture's JTextComponent.

Specified by:

enterText in interface TextInputFixture<JTextComponentFixture>

Parameters:

text - the text to enter.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

setText

@Nonnull
public JTextComponentFixture setText(@Nullable
                                    String text)

Sets the text in this fixture's JTextComponent. Unlike enterText(String), this method bypasses the event system and allows immediate updating on the underlying document model.

Primarily desired for speeding up tests when precise user event fidelity isn't necessary.

Parameters:

text - the text to set.

Returns:

this fixture.

Throws:

IllegalStateException - if this fixture's JTextComponent is disabled.

IllegalStateException - if this fixture's JTextComponent is not showing on the screen.

requireText

@Nonnull
public JTextComponentFixture requireText(@Nullable
                                        String expected)

Asserts that the text of this fixture's JTextComponent is equal to the specified value.

Specified by:

requireText in interface TextDisplayFixture<JTextComponentFixture>

Parameters:

expected - the text to match. It can be a regular expression pattern.

Returns:

this fixture.

Throws:

AssertionError - if the text of this fixture's JTextComponent is not equal to the given one.

requireText

@Nonnull
public JTextComponentFixture requireText(@Nonnull
                                        Pattern pattern)

Asserts that the text of this fixture's JTextComponent matches the given regular expression pattern.

Specified by:

requireText in interface TextDisplayFixture<JTextComponentFixture>

Parameters:

pattern - the regular expression pattern to match.

Returns:

this fixture.

Throws:

NullPointerException - if the given regular expression pattern is null.

AssertionError - if the text of this fixture's JTextComponent is not eual to the given one.

requireEditable

@Nonnull
public JTextComponentFixture requireEditable()

Asserts that this fixture's JTextComponent is editable.

Specified by:

requireEditable in interface EditableComponentFixture<JTextComponentFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JTextComponent is not editable.

requireNotEditable

@Nonnull
public JTextComponentFixture requireNotEditable()

Asserts that this fixture's JTextComponent is not editable.

Specified by:

requireNotEditable in interface EditableComponentFixture<JTextComponentFixture>

Returns:

this fixture.

Throws:

AssertionError - if this fixture's JTextComponent is editable.

requireEmpty

@Nonnull
public JTextComponentFixture requireEmpty()

Asserts that the target text component does not contain any text.

Returns:

this fixture.

Throws:

AssertionError - if the target text component is not empty.