org.assertj.swing.core

Class BasicComponentPrinter

java.lang.Object

org.assertj.swing.core.BasicComponentPrinter

All Implemented Interfaces:

ComponentPrinter

public final class BasicComponentPrinter
extends Object
implements ComponentPrinter

Default implementation of ComponentPrinter.

Author:

Alex Ruiz

See Also:

ComponentPrinter, Formatting.format(Component)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicComponentPrinter(ComponentHierarchy hierarchy) Creates a new BasicComponentPrinter.

Method Summary

Methods

Modifier and Type	Method and Description
protected ComponentHierarchy	hierarchy()
void	printComponents(PrintStream out) Prints all the AWT and Swing Components in the hierarchy.
void	printComponents(PrintStream out, Class<? extends Component> type) Prints only the AWT and Swing Components of the given type in the hierarchy.
void	printComponents(PrintStream out, Class<? extends Component> type, Container root) Prints all the AWT and Swing Components of the given type in the hierarchy under the given root.
void	printComponents(PrintStream out, ComponentMatcher matcher) Prints only the AWT and Swing Components that match the given search criteria in the hierarchy.
void	printComponents(PrintStream out, ComponentMatcher matcher, Container root) Prints all the AWT and Swing Components that match the given search criteria under the given root.
void	printComponents(PrintStream out, Container root) Prints all the AWT and Swing Components in the hierarchy under the given root.
static ComponentPrinter	printerWithCurrentAwtHierarchy() Creates a new BasicComponentPrinter that has access to all the AWT and Swing Components in the AWT hierarchy.
static ComponentPrinter	printerWithNewAwtHierarchy() Creates a new BasicComponentPrinter with a new AWT hierarchy.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicComponentPrinter

protected BasicComponentPrinter(@Nonnull
                     ComponentHierarchy hierarchy)

Creates a new BasicComponentPrinter.

Parameters:

hierarchy - the component hierarchy to use.

Method Detail

printerWithNewAwtHierarchy

@Nonnull
public static ComponentPrinter printerWithNewAwtHierarchy()

Creates a new BasicComponentPrinter with a new AWT hierarchy. AWT and Swing Components created before the created BasicComponentPrinter cannot be accessed by the created BasicComponentPrinter.

Returns:

the created finder.

printerWithCurrentAwtHierarchy

@Nonnull
public static ComponentPrinter printerWithCurrentAwtHierarchy()

Creates a new BasicComponentPrinter that has access to all the AWT and Swing Components in the AWT hierarchy.

Returns:

the created printer.

hierarchy

@Nonnull
protected final ComponentHierarchy hierarchy()

Returns:

the component hierarchy used by this printer.

printComponents

@RunsInEDT
public void printComponents(@Nonnull
                             PrintStream out)

Description copied from interface: ComponentPrinter

Prints all the AWT and Swing Components in the hierarchy.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

See Also:

Formatting.format(Component)

printComponents

@RunsInEDT
public void printComponents(@Nonnull
                             PrintStream out,
                             @Nullable
                             Container root)

Description copied from interface: ComponentPrinter

Prints all the AWT and Swing Components in the hierarchy under the given root.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

root - the root used as the starting point of the search.

See Also:

Formatting.format(Component)

printComponents

@RunsInEDT
public void printComponents(@Nonnull
                             PrintStream out,
                             @Nonnull
                             Class<? extends Component> type)

Description copied from interface: ComponentPrinter

Prints only the AWT and Swing Components of the given type in the hierarchy.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

type - the type of Components to print.

See Also:

Formatting.format(Component)

printComponents

@RunsInEDT
public void printComponents(@Nonnull
                             PrintStream out,
                             @Nonnull
                             Class<? extends Component> type,
                             @Nullable
                             Container root)

Description copied from interface: ComponentPrinter

Prints all the AWT and Swing Components of the given type in the hierarchy under the given root.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

type - the type of Components to print.

root - the root used as the starting point of the search.

See Also:

Formatting.format(Component)

printComponents

public void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   ComponentMatcher matcher)

Description copied from interface: ComponentPrinter

Prints only the AWT and Swing Components that match the given search criteria in the hierarchy.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

matcher - specifies the search criteria to use filter the Components to print.

See Also:

Formatting.format(Component)

printComponents

public void printComponents(@Nonnull
                   PrintStream out,
                   @Nonnull
                   ComponentMatcher matcher,
                   @Nullable
                   Container root)

Description copied from interface: ComponentPrinter

Prints all the AWT and Swing Components that match the given search criteria under the given root.

Specified by:

printComponents in interface ComponentPrinter

Parameters:

out - the output stream where to print the Components to.

matcher - specifies the search criteria to use filter the Components to print.

root - the root used as the starting point of the search.

See Also:

Formatting.format(Component)