public interface FilterBuilder
Filter
instances for a single
type of filters. Provides also the settings panel for the type of filter.
Implementors should add the @ServiceProvider
annotation to be
registered by the system or call FilterLibrary.addBuilder()
.
The JPanel
returned by the getPanel()
method is the
settings panel that configures the filter parameters. These parameters can be
get and set by using Filter.getProperties()
. Settings panel should
always set parameters values in that way. As a result the system will be
aware values changed and update the filter.
See CategoryBuilder
for builders that host multiple types of filters.
FilterLibrary
Modifier and Type | Method and Description |
---|---|
void |
destroy(Filter filter)
Notification when the filter is destroyed, to perform clean-up tasks.
|
Category |
getCategory()
Returns the category this filter builder belongs to.
|
String |
getDescription()
Returns this description text of this filter builder
|
Filter |
getFilter(Workspace workspace)
Builds a new
Filter instance. |
Icon |
getIcon()
Returns the icon of this filter builder
|
String |
getName()
Returns the display name of this filter builder
|
JPanel |
getPanel(Filter filter)
Returns the settings panel for the filter this builder is building, the
filter object is passed as a parameter. |
Category getCategory()
String getName()
Icon getIcon()
String getDescription()
Filter getFilter(Workspace workspace)
Filter
instance.workspace
- workspaceFilter
objectJPanel getPanel(Filter filter)
filter
object is passed as a parameter.filter
- the filter that the panel is to be configuringvoid destroy(Filter filter)
filter
- filter to be destroyedCopyright © 2007–2017 Gephi Consortium. All rights reserved.