|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FilterBuilder
Filter builder, creating 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
Method Summary | |
---|---|
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. |
java.lang.String |
getDescription()
Returns ths description text of this filter builder |
Filter |
getFilter()
Builds a new Filter instance. |
javax.swing.Icon |
getIcon()
Returns the icon of this filter builder |
java.lang.String |
getName()
Returns the display name of this filter builder |
javax.swing.JPanel |
getPanel(Filter filter)
Returns the settings panel for the filter this builder is building, the filter object is passed as a parameter. |
Method Detail |
---|
Category getCategory()
java.lang.String getName()
javax.swing.Icon getIcon()
java.lang.String getDescription()
Filter getFilter()
Filter
instance.
Filter
objectjavax.swing.JPanel getPanel(Filter filter)
filter
object is passed as a parameter.
filter
- the filter that the panel is to be configuring
void destroy(Filter filter)
|
Gephi Toolkit Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |