com.nitorcreations.test.wicket

Class Selection<T extends org.apache.wicket.Component>

java.lang.Object

com.nitorcreations.test.wicket.Selection<T>

Type Parameters:

T - the type of the component to find

public final class Selection<T extends org.apache.wicket.Component>
extends Object

A utility that can be used to find specific components in Wicket's component hierarchy. Example use:

 Label label = select(Label.class).withId("name").that(is(visibleInHierarchy())).firstFrom(wmc);
 

Method Summary

Methods

Modifier and Type	Method and Description
<X extends T> X	firstFrom(org.apache.wicket.MarkupContainer container) Get the first element matching the given set of matchers.
<X extends T> X	firstOrNullFrom(org.apache.wicket.MarkupContainer container) Get the first element matching the given set of matchers from the given container.
<X extends T> List<X>	from(org.apache.wicket.MarkupContainer container) List the components matching the given set of matchers that reside under container in the hierarchy.
static <T extends org.apache.wicket.Component> Selection<T>	select(Class<T> clazz)
static <T extends org.apache.wicket.Component> Selection<T>	select(Class<T> clazz, String markupId)
static Selection<org.apache.wicket.Component>	selectWithId(String markupId)
Selection<T>	that(org.hamcrest.Matcher<? super T> matcher) Add the given matcher to the set of matchers to use when searching for the components.
Selection<T>	withId(String markupId)

Methods inherited from class java.lang.Object

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

Method Detail

select

public static <T extends org.apache.wicket.Component> Selection<T> select(Class<T> clazz)

select

public static <T extends org.apache.wicket.Component> Selection<T> select(Class<T> clazz,
                                                          String markupId)

selectWithId

public static Selection<org.apache.wicket.Component> selectWithId(String markupId)

that

public Selection<T> that(org.hamcrest.Matcher<? super T> matcher)

Add the given matcher to the set of matchers to use when searching for the components.

Parameters:

matcher - the matcher to add

Returns:

this to allow chaining

See Also:

from(org.apache.wicket.MarkupContainer)

withId

public Selection<T> withId(String markupId)

from

public <X extends T> List<X> from(org.apache.wicket.MarkupContainer container)

List the components matching the given set of matchers that reside under container in the hierarchy.

Type Parameters:

X - the type of the returned components

Parameters:

container - the container to search for

Returns:

the list of found components or empty if none found

See Also:

firstFrom

public <X extends T> X firstFrom(org.apache.wicket.MarkupContainer container)

Get the first element matching the given set of matchers. Will throw an IllegalArgumentException if no components matching the given set of matchers were found in the given container.

Type Parameters:

X - the type of the returned components

Parameters:

container - the container to search for

Returns:

the first matching component

See Also:

from(org.apache.wicket.MarkupContainer), firstOrNullFrom(org.apache.wicket.MarkupContainer)

firstOrNullFrom

public <X extends T> X firstOrNullFrom(org.apache.wicket.MarkupContainer container)

Get the first element matching the given set of matchers from the given container. Will return null if none found.

Type Parameters:

X - the type of the returned components

Parameters:

container - the container to search for

Returns:

the first matching component or null if none found.

See Also:

from(org.apache.wicket.MarkupContainer), firstFrom(org.apache.wicket.MarkupContainer)