Interface PipelineBlockPrototype
-
- All Known Implementing Classes:
AbstractBlockPrototype
,DelayBlockPrototype
,ExpressionBlockPrototype
,JumpBlockPrototype
,LegacyNotificationPrototype
,NotificationBlockPrototype
,PropertySetterBlockPrototype
,ScriptableBlockPrototype
,SplitterBlockPrototype
,SwitchBlockPrototype
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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 blockjava.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.
-
-
-
Method Detail
-
createNewBlock
ObservablePropertySet createNewBlock()
Create a new property set to represent this block
-
getTitle
LocalizedString getTitle()
- Returns:
- the title for the block
-
getIcon
javax.swing.Icon getIcon()
- Returns:
- A 32x32 icon for the palette
-
getRolloverIcon
javax.swing.Icon getRolloverIcon()
- Returns:
- Rollover version of the palette icon.
-
getSmallIcon
javax.swing.Icon getSmallIcon()
- Returns:
- Small 16x16 icon for the title of the block
-
createEditingUI
javax.swing.JComponent createEditingUI(DesignerContext context, PropertySet block)
Create a new editing UI for the given block. Note that your component may implementPipelineBlockEditor
to get callbacks on uninstall
-
getFactoryId
java.lang.String getFactoryId()
Return the factory id of blocks created with this prototype.
-
getOutputs
java.util.List<OutputDescriptor> getOutputs(ObservablePropertySet block)
-
getBlockMutatingProperties
java.util.Collection<Property<?>> getBlockMutatingProperties()
Which properties (if any) are able to alter the structure of the block (number/names of outputs)
-
getSearchableProperties
java.util.Collection<Property<?>> getSearchableProperties(PropertySet block)
Which properties (if any) are eligible for the search and replace system.- Parameters:
block
- The block in question
-
isPreviewPanelSupported
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.
-
initPreviewPanel
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.
-
isSystemOnly
boolean isSystemOnly()
Returns whether only the system can programmatically create these types of blocks. If false, the user will be able to create them from the palette.
-
-