org.hkijena.jipipe.desktop.api

Class JIPipeDesktopParameterEditorUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.hkijena.jipipe.desktop.app.JIPipeDesktopWorkbenchPanel

org.hkijena.jipipe.desktop.api.JIPipeDesktopParameterEditorUI

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JIPipeWorkbenchAccess, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeDesktopWorkbenchAccess, Contextual, Disposable

Direct Known Subclasses:

AnchorDesktopParameterEditorUI, BooleanDesktopParameterEditorUI, ColorDesktopParameterEditorUI, DesktopParameterCollectionListEditorUI, DesktopParameterTableEditorUI, DynamicEnumDesktopParameterEditorUI, DynamicSetDesktopParameterEditorUI, EnumDesktopParameterEditorUI, FileDesktopParameterEditorUI, FilePathDesktopParameterEditorUI, FixedMarginEditorUIDesktop, FunctionDesktopParameterEditorUI, GraphNodeParameterReferenceGroupCollectionDesktopParameterEditorUI, HTMLTextDesktopParameterEditorUI, IconRefDesktopParameterEditorUI, ImageDesktopParameterEditorUI, ImageJDataExporterRefDesktopParameterEditorUI, ImageJDataExportOperationRefDesktopParameterEditorUI, ImageJDataImporterRefDesktopParameterEditorUI, ImageJDataImportOperationRefDesktopParameterEditorUI, InnerMarginEditorUIDesktop, IntegerRangeDesktopParameterEditorUI, JIPipeAuthorMetadataDesktopParameterEditorUI, JIPipeDataInfoRefDesktopParameterEditorUI, JIPipeDesktopArtifactQueryParameterEditorUI, JIPipeDesktopExternalEnvironmentParameterEditorUI, JIPipeExpressionDesktopParameterEditorUI, JIPipeNodeInfoRefDesktopParameterEditorUI, JIPipeNodeTemplateDesktopParameterEditorUI, JIPipeParameterCollectionDesktopParameterEditorUI, JIPipeParameterCollectionVisibilitiesDesktopParameterEditorUI, JIPipeParameterTypeInfoRefDesktopParameterEditorUI, LargeScriptDesktopParameterEditorUI, ListDesktopParameterEditorUI, MarginDesktopParameterEditorUI, Matrix2DDesktopParameterEditorUI, NodeGroupContentsDesktopParameterEditorUI, NumberDesktopParameterEditorUI, NumberRangeDesktopParameterEditorUI, OMEAccessorDesktopParameterEditorUI, OptionalDesktopParameterEditorUI, PairDesktopParameterEditorUI, PasswordDesktopParameterEditorUI, QuantityDesktopParameterEditorUI, RectangleDesktopParameterEditorUI, ResultsTableDataDesktopParameterEditorUI, RuntimePartitionReferenceDesktopParameterEditorUI, ScriptDesktopParameterEditorUI, StringDesktopParameterEditorUI, StringOrDoubleDesktopParameterEditorUI, StringPatternExtractionDesktopParameterEditorUI, TableColumnGeneratorDesktopParameterEditorUI, UIPlotDataSeriesColumnEnumDesktopParameterEditorUI, VectorDesktopParameterEditorUI, WekaClassifierDesktopParameterEditorUI

public abstract class JIPipeDesktopParameterEditorUI
extends JIPipeDesktopWorkbenchPanel
implements Contextual, Disposable, JIPipeParameterCollection.ParameterChangedEventListener

A UI for a parameter type

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTROL_STYLE_CHECKBOX
static int	CONTROL_STYLE_LIST
static int	CONTROL_STYLE_PANEL

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JIPipeDesktopParameterEditorUI(JIPipeDesktopWorkbench workbench, JIPipeParameterTree parameterTree, JIPipeParameterAccess parameterAccess) Creates new instance

Method Summary

Modifier and Type	Method and Description
Context	context()
void	dispose()
JIPipeDesktopGraphCanvasUI	getCanvasUI() Finds the graph canvas if one is available
Context	getContext()
<T> T	getParameter(Class<T> klass) Gets or creates a parameter instance.
JIPipeParameterAccess	getParameterAccess() Gets the parameter accessor
JIPipeParameterCollection	getParameterCollection() Gets the object that holds the parameter
Class<?>	getParameterFieldClass() Returns the field class of the parameter
JIPipeParameterTree	getParameterTree()
JIPipeParameterTypeInfo	getParameterTypeInfo() Returns the info for the current parameter type
int	getUIControlStyleType() Returns the "style" of the control.
boolean	isUIImportantLabelEnabled() If true, the JIPipeDesktopParameterFormPanel will render an "important" label if the parameter is marked as important.
abstract boolean	isUILabelEnabled() If true, the JIPipeDesktopParameterFormPanel will display a label with the parameter name next to this UI.
void	onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event) Listens for changes in parameters
abstract void	reload() Reloads the value from the stored parameter
void	setContext(Context context)
boolean	setParameter(Object parameter, boolean reload) Sets the parameter value.

Methods inherited from class org.hkijena.jipipe.desktop.app.JIPipeDesktopWorkbenchPanel

getDesktopWorkbench, getWorkbench

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTROL_STYLE_PANEL

public static final int CONTROL_STYLE_PANEL

See Also:

Constant Field Values

CONTROL_STYLE_LIST

public static final int CONTROL_STYLE_LIST

See Also:

Constant Field Values

CONTROL_STYLE_CHECKBOX

public static final int CONTROL_STYLE_CHECKBOX

See Also:

Constant Field Values

Constructor Detail

JIPipeDesktopParameterEditorUI

public JIPipeDesktopParameterEditorUI(JIPipeDesktopWorkbench workbench,
                                      JIPipeParameterTree parameterTree,
                                      JIPipeParameterAccess parameterAccess)

Creates new instance

Parameters:

workbench - the workbench

parameterTree - the parameter tree that contains the access

parameterAccess - the parameter access

Method Detail

getParameterCollection

public JIPipeParameterCollection getParameterCollection()

Gets the object that holds the parameter

Returns:

object that holds the parameter

getParameter

public <T> T getParameter(Class<T> klass)

Gets or creates a parameter instance. Safe to be called within reload()

Type Parameters:

T - parameter class

Parameters:

klass - parameter class

Returns:

parameter instance. never null.

setParameter

public boolean setParameter(Object parameter,
                            boolean reload)

Sets the parameter value. Can prevent reload()

Parameters:

parameter - the value

reload - if enabled, a reload can happen.

Returns:

if the parameter was set

getCanvasUI

public JIPipeDesktopGraphCanvasUI getCanvasUI()

Finds the graph canvas if one is available

Returns:

the canvas or null

getParameterTree

public JIPipeParameterTree getParameterTree()

getParameterAccess

public JIPipeParameterAccess getParameterAccess()

Gets the parameter accessor

Returns:

parameter accessor

getParameterFieldClass

public Class<?> getParameterFieldClass()

Returns the field class of the parameter

Returns:

the field class

getParameterTypeInfo

public JIPipeParameterTypeInfo getParameterTypeInfo()

Returns the info for the current parameter type

Returns:

the parameter type info

isUILabelEnabled

public abstract boolean isUILabelEnabled()

If true, the JIPipeDesktopParameterFormPanel will display a label with the parameter name next to this UI.

Returns:

if label should be shown

isUIImportantLabelEnabled

public boolean isUIImportantLabelEnabled()

If true, the JIPipeDesktopParameterFormPanel will render an "important" label if the parameter is marked as important.

Returns:

if an automatically generated "important" label should be displayed

getUIControlStyleType

public int getUIControlStyleType()

Returns the "style" of the control. This is only utilized for the automated ordering within JIPipeDesktopParameterFormPanel Controls with the same style are grouped together to ensure a consistent visual style (reduce clutter) Please note that the grouping enforced by isUILabelEnabled() has precedence

Returns:

the UI control style for JIPipeDesktopParameterFormPanel (sorting only)

reload

public abstract void reload()

Reloads the value from the stored parameter

onParameterChanged

public void onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event)

Listens for changes in parameters

Specified by:

onParameterChanged in interface JIPipeParameterCollection.ParameterChangedEventListener

Parameters:

event - Generated event

dispose

public void dispose()

Specified by:

dispose in interface Disposable

context

public Context context()

Specified by:

context in interface Contextual

getContext

public Context getContext()

Specified by:

getContext in interface Contextual

setContext

public void setContext(Context context)

Specified by:

setContext in interface Contextual