Package org.gephi.appearance.spi
Interface TransformerUI<T extends Transformer>
-
- Type Parameters:
T
- transformer class
public interface TransformerUI<T extends Transformer>
Defines the user interface associated with a transformer.It is a one-to-one relationship as only a single transformer UI can be associated with a transformer.
Implementations of this class should be singleton services by adding the
@ServiceProvider
annotation:@ServiceProvider(service = TransformerUI.class, position = 2000)
The position parameter is optional but can be used to control the order in which the transformers appear in the user interface. The higher the last.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TransformerCategory
getCategory()
Returns the transformer category.AbstractButton[]
getControlButton()
Returns the control buttons associated with this transformer.String
getDescription()
Returns the transformer's description.String
getDisplayName()
Returns the transformer's display name.Icon
getIcon()
Returns the transformer's icon.JPanel
getPanel(Function function)
Returns the transformer panel for the given function.Class<? extends T>
getTransformerClass()
Returns the transformer class this transformer UI is associated with.
-
-
-
Method Detail
-
getCategory
TransformerCategory getCategory()
Returns the transformer category.- Returns:
- transformer category
-
getPanel
JPanel getPanel(Function function)
Returns the transformer panel for the given function.- Parameters:
function
- function- Returns:
- transformer panel
-
getDisplayName
String getDisplayName()
Returns the transformer's display name.- Returns:
- display name
-
getDescription
String getDescription()
Returns the transformer's description.- Returns:
- description or null if missing
-
getIcon
Icon getIcon()
Returns the transformer's icon.- Returns:
- icon or null if missing
-
getControlButton
AbstractButton[] getControlButton()
Returns the control buttons associated with this transformer.- Returns:
- control buttons or null if missing
-
-