org.gephi.datalab.api.datatables

Interface DataTablesController

All Superinterfaces:

DataTablesCommonInterface

All Known Implementing Classes:

DataTablesControllerImpl

public interface DataTablesController
extends DataTablesCommonInterface

This interface defines part of the Data Laboratory API.

It provides methods to control the Data Table UI that shows a table for nodes and edges.

This is done by registering the data table ui as a listener of these events that can be requested with this controller. Note that data table ui will not be registered to listen to the events of this controller until it is instanced opening Data Laboratory Group

Author:

Eduardo Ramos

Nested Class Summary

Nested classes/interfaces inherited from interface org.gephi.datalab.api.datatables.DataTablesCommonInterface

DataTablesCommonInterface.ExportMode

Method Summary

Methods

Modifier and Type	Method and Description
DataTablesEventListener	getDataTablesEventListener() Returns the current registered DataTablesEventListener.
boolean	isDataTablesReady() Indicates if Data Table UI is registered as a listener of the events created by this controller.
boolean	prepareDataTables() Looks for an available DataTablesEventListenerBuilder and sets its DataTablesEventListener.
void	selectTable(org.gephi.graph.api.Table table) Request the tables implementation to show the given table (nodes or edges table)
void	setDataTablesEventListener(DataTablesEventListener listener) Register a listener for these requests.

Methods inherited from interface org.gephi.datalab.api.datatables.DataTablesCommonInterface

exportCurrentTable, getEdgeTableSelection, getNodeTableSelection, isAutoRefreshEnabled, isEdgeTableMode, isNodeTableMode, isShowEdgesNodesLabels, isShowOnlyVisible, isTimeIntervalGraphics, isUseSparklines, refreshCurrentTable, selectEdgesTable, selectNodesTable, setAutoRefreshEnabled, setEdgeTableSelection, setNodeTableSelection, setShowEdgesNodesLabels, setShowOnlyVisible, setTimeIntervalGraphics, setUseSparklines

Method Detail

selectTable

void selectTable(org.gephi.graph.api.Table table)

Request the tables implementation to show the given table (nodes or edges table)

Parameters:

table - Table to show

setDataTablesEventListener

void setDataTablesEventListener(DataTablesEventListener listener)

Register a listener for these requests.

Parameters:

listener - Instance of DataTablesEventListener

getDataTablesEventListener

DataTablesEventListener getDataTablesEventListener()

Returns the current registered DataTablesEventListener. It can be null if it is still not activated or there is no active workspace.

Returns:

Current listener or null

isDataTablesReady

boolean isDataTablesReady()

Indicates if Data Table UI is registered as a listener of the events created by this controller.

Returns:

True if Data Table UI is prepared, false otherwise

prepareDataTables

boolean prepareDataTables()

Looks for an available DataTablesEventListenerBuilder and sets its DataTablesEventListener.

Returns:

True if listener found, false otherwise