review.classdesign.jammy.ui.internal

Class ListPageBuilder

java.lang.Object

review.classdesign.jammy.ui.internal.ListPageBuilder

public final class ListPageBuilder
extends java.lang.Object

A ListPageBuilder allows to build a WizardPage that aims to display a list of object.

Author:

fv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ListPageBuilder.ListPage Custom wizard page implementation that displays a list based on the builder parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.function.Consumer<java.lang.Object>	consumer Selection consumer that will handle user selection.
private org.eclipse.jface.viewers.IContentProvider	contentProvider Content provider instance used by the created list.
private java.lang.String	description Description of the created page.
private org.eclipse.jface.viewers.IBaseLabelProvider	labelProvider Label provider instance used by the created list.
private java.lang.String	name Name of the created page.

Constructor Summary

Constructors

Constructor and Description
ListPageBuilder(java.lang.String name) Default constructor.

Method Summary

Modifier and Type	Method and Description
ListPageBuilder.ListPage	build() Builds and returns the wizard page instance that will display the list.
ListPageBuilder	contentProvider(org.eclipse.jface.viewers.IContentProvider contentProvider) Sets the content provider used by the displayed list.
private org.eclipse.jface.viewers.ListViewer	createListViewer(org.eclipse.swt.widgets.Composite parent) Factory method that creates a ListViewer instance from this builder internal attributes, which is bind to the given parent container.
ListPageBuilder	description(java.lang.String description) Sets the created page description.
ListPageBuilder	labelProvider(org.eclipse.jface.viewers.IBaseLabelProvider labelProvider) Sets the label provider used by the displayed list.
ListPageBuilder	selectionConsumer(java.util.function.Consumer<java.lang.Object> consumer) Sets the consumer that will be used for handling user selection through the list.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

Name of the created page.

description

private java.lang.String description

Description of the created page.

consumer

private java.util.function.Consumer<java.lang.Object> consumer

Selection consumer that will handle user selection.

contentProvider

private org.eclipse.jface.viewers.IContentProvider contentProvider

Content provider instance used by the created list.

labelProvider

private org.eclipse.jface.viewers.IBaseLabelProvider labelProvider

Label provider instance used by the created list.

Constructor Detail

ListPageBuilder

public ListPageBuilder(java.lang.String name)

Default constructor.

Parameters:

name - Name of the created page.

Method Detail

description

public ListPageBuilder description(java.lang.String description)

Sets the created page description.

Parameters:

description - Description of the target page.

Returns:

Reference of this builder in order to chain call.

selectionConsumer

public ListPageBuilder selectionConsumer(java.util.function.Consumer<java.lang.Object> consumer)

Sets the consumer that will be used for handling user selection through the list.

Parameters:

consumer - Selection consumer that will handle user selection.

Returns:

Reference of this builder in order to chain call.

contentProvider

public ListPageBuilder contentProvider(org.eclipse.jface.viewers.IContentProvider contentProvider)

Sets the content provider used by the displayed list.

Parameters:

contentProvider - Content provider instance used by the created list.

Returns:

Reference of this builder in order to chain call.

labelProvider

public ListPageBuilder labelProvider(org.eclipse.jface.viewers.IBaseLabelProvider labelProvider)

Sets the label provider used by the displayed list.

Parameters:

labelProvider - Label provider instance used by the created list.

Returns:

Reference of this builder in order to chain call.

createListViewer

private org.eclipse.jface.viewers.ListViewer createListViewer(org.eclipse.swt.widgets.Composite parent)

Factory method that creates a ListViewer instance from this builder internal attributes, which is bind to the given parent container.

Parameters:

parent - Parent composite container which should own the created component.

Returns:

Created viewer.

build

public ListPageBuilder.ListPage build()

Builds and returns the wizard page instance that will display the list. TODO : Check for null parameters.

Returns:

Built wizard page.