org.gephi.ranking.spi
Interface TransformerUI

public interface TransformerUI

Transformer user interface. Implement this interface to create panels associated to a particular transformer.

The icon and display name are used to create the transformer button in the UI.

Implementors should add the @ServiceProvider annotation to be registered by the system.

Author:

Mathieu Bastian

See Also:

Transformer

Method Summary

java.lang.String	getDisplayName() Returns the display name of the transformer
javax.swing.Icon	getIcon() Returns the transformer's icon
javax.swing.JPanel	getPanel(Transformer transformer, Ranking ranking) Returns the panel associated to this transformer.
boolean	isUIForTransformer(Transformer transformer) Returns true if this UI is built for transformer.

Method Detail

getIcon

javax.swing.Icon getIcon()

Returns the transformer's icon

Returns:

the icon of this transformer

getDisplayName

java.lang.String getDisplayName()

Returns the display name of the transformer

Returns:

the display name of this transformer

getPanel

javax.swing.JPanel getPanel(Transformer transformer,
                            Ranking ranking)

Returns the panel associated to this transformer.

Parameters:

transformer - the transformer to build the panel for

ranking - the ranking to be used by the transformer

Returns:

the panel of this transformer

isUIForTransformer

boolean isUIForTransformer(Transformer transformer)

Returns true if this UI is built for transformer.

Parameters:

transformer - the transformer to test ownership

Returns:

true if this UI is associated to transformer, false otherwise