public interface PipelineBlockPrototype
A pipeline block prototype describes a pipeline's general nature for the purposes of visual design within the pipeline design workspace.
If a module wishes to add a new type of pipeline block, they must register a prototype with the
DesignerContext
Modifier and Type | Method and Description |
---|---|
javax.swing.JComponent |
createEditingUI(DesignerContext context,
PropertySet block)
Create a new editing UI for the given block.
|
ObservablePropertySet |
createNewBlock()
Create a new property set to represent this block
|
java.util.Collection<Property<?>> |
getBlockMutatingProperties()
Which properties (if any) are able to alter the structure of the block (number/names of outputs)
|
java.lang.String |
getFactoryId()
Return the factory id of blocks created with this prototype.
|
javax.swing.Icon |
getIcon() |
java.util.List<OutputDescriptor> |
getOutputs(ObservablePropertySet block) |
javax.swing.Icon |
getRolloverIcon() |
java.util.Collection<Property<?>> |
getSearchableProperties(PropertySet block)
Which properties (if any) are eligible for the search and replace system.
|
javax.swing.Icon |
getSmallIcon() |
LocalizedString |
getTitle() |
void |
initPreviewPanel(ObservablePropertySet block,
javax.swing.JPanel panel)
Used to initialize a small preview of the block's properties, which is displayed beneath the block.
|
boolean |
isPreviewPanelSupported()
Return true here if you want to add extra information to the block display on a preview panel beneath the
input/output pins.
|
boolean |
isSystemOnly()
Returns whether only the system can programmatically create these types of blocks.
|
ObservablePropertySet createNewBlock()
LocalizedString getTitle()
javax.swing.Icon getIcon()
javax.swing.Icon getRolloverIcon()
javax.swing.Icon getSmallIcon()
javax.swing.JComponent createEditingUI(DesignerContext context, PropertySet block)
PipelineBlockEditor
to get callbacks on uninstalljava.lang.String getFactoryId()
java.util.List<OutputDescriptor> getOutputs(ObservablePropertySet block)
java.util.Collection<Property<?>> getBlockMutatingProperties()
java.util.Collection<Property<?>> getSearchableProperties(PropertySet block)
block
- The block in questionboolean isPreviewPanelSupported()
void initPreviewPanel(ObservablePropertySet block, javax.swing.JPanel panel)
boolean isSystemOnly()