Package org.eclipse.jface.widgets

Class TableFactory

java.lang.Object

org.eclipse.jface.widgets.AbstractWidgetFactory<F,C,Composite>

org.eclipse.jface.widgets.AbstractControlFactory<TableFactory,Table>

org.eclipse.jface.widgets.TableFactory

public final class TableFactory
extends AbstractControlFactory<TableFactory,Table>

This class provides a convenient shorthand for creating and initializing Table. This offers several benefits over creating Table normal way:

• The same factory can be used many times to create several Table instances
• The setters on TableFactory all return "this", allowing them to be chained
• TableFactory accepts a Lambda for SelectionEvent (see onSelect(java.util.function.Consumer<org.eclipse.swt.events.SelectionEvent>))

Example usage:

 Table table = TableFactory.newTable(SWT.CHECK) //
                .headerVisible(true) //
                .linesVisible(true) //
                .onSelect(e -> tableClicked(e)) //
                .create(parent);
 

The above example creates a table, sets some properties, registers a SelectionListener and finally creates the table in "parent".

Note that this class does not extend AbstractCompositeFactory even though Table extends Composite. This is because Table is not supposed to be used like a Composite.

Since:

3.18

Method Summary

Modifier and Type	Method	Description
TableFactory	headerVisible(boolean visible)	Marks the receiver's header as visible if the argument is true, and marks it invisible otherwise.
TableFactory	itemCount(int count)	Sets the number of items contained in the receiver.
TableFactory	linesVisible(boolean visible)	Marks the receiver's lines as visible if the argument is true, and marks it invisible otherwise.
static TableFactory	newTable(int style)	Creates a new TableFactory with the given style.
TableFactory	onSelect(Consumer<SelectionEvent> consumer)	Creates a SelectionListener and registers it for the widgetSelected event.

Methods inherited from class org.eclipse.jface.widgets.AbstractControlFactory

background, enabled, font, foreground, layoutData, orientation, supplyLayoutData, tooltip

Methods inherited from class org.eclipse.jface.widgets.AbstractWidgetFactory

addProperty, cast, create, data, data

Methods inherited from class java.lang.Object

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

Method Details

newTable

public static TableFactory newTable(int style)

Creates a new TableFactory with the given style. Refer to Table(Composite, int) for possible styles.

Returns:

a new TableFactory instance

onSelect

public TableFactory onSelect(Consumer<SelectionEvent> consumer)

Creates a SelectionListener and registers it for the widgetSelected event. If the receiver is selected by the user the given consumer is invoked. The SelectionEvent is passed to the consumer.

Parameters:

consumer - the consumer whose accept method is called

Returns:

this

See Also:

• Table.addSelectionListener(SelectionListener)
• SelectionListener.widgetSelectedAdapter(Consumer)

headerVisible

public TableFactory headerVisible(boolean visible)

Marks the receiver's header as visible if the argument is true, and marks it invisible otherwise.

Parameters:

visible - the visibility state

Returns:

this

See Also:

• Table.setHeaderVisible(boolean)

linesVisible

public TableFactory linesVisible(boolean visible)

Marks the receiver's lines as visible if the argument is true, and marks it invisible otherwise. Note that some platforms draw grid lines while others may draw alternating row colors.

Parameters:

visible - the visibility state

Returns:

this

See Also:

• Table.setLinesVisible(boolean)

itemCount

public TableFactory itemCount(int count)

Sets the number of items contained in the receiver.

Parameters:

count - the number of items

Returns:

this

See Also:

• Table.setItemCount(int)