org.hkijena.jipipe.ui.cache

Class JIPipeCacheDataViewerWindow

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.hkijena.jipipe.ui.cache.JIPipeCacheDataViewerWindow

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

CachedImagePlusDataViewerWindow, CachedParametersDataViewerWindow, CachedPlotViewerWindow, CachedROIListDataViewerWindow, CachedSpotCollectionDataViewerWindow, CachedTableViewerWindow, CachedTextViewerWindow, CachedTrackmateAlgorithmViewerWindow, CachedTracksCollectionDataViewerWindow, TrackSchemeCachedDataViewerWindow

public abstract class JIPipeCacheDataViewerWindow
extends JFrame

Base class for a Window that displays cached data.

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JIPipeCacheDataViewerWindow(JIPipeWorkbench workbench, JIPipeDataTableDataSource dataSource, String displayName)

Method Summary

Modifier and Type	Method and Description
protected abstract void	afterSetRow() Called after the data row was changed
protected abstract void	beforeSetRow() Called before the data row is changed
JIPipeAlgorithm	getAlgorithm()
Container	getContentPane()
Function<JIPipeVirtualData,JIPipeVirtualData>	getDataConverterFunction()
JIPipeDataTableDataSource	getDataSource()
String	getDisplayName()
JToolBar	getPinToolBar() The toolbar where the window pin controls are added.
JIPipeProject	getProject()
String	getSlotName()
JLabel	getStandardErrorLabel() Returns a standard error label that simplifies the creation of cache windows.
abstract JToolBar	getToolBar() Returns the toolbar that contains
JIPipeWorkbench	getWorkbench()
void	gotoNextRow()
protected void	hideErrorUI() Instruction to remove the error UI By default, it will hide the standard error label
protected abstract void	loadData(JIPipeVirtualData virtualData, JIPipeProgressInfo progressInfo) Instruction to load the data from the current data source
void	onCacheUpdated(JIPipeProjectCache.ModifiedEvent event)
void	reloadDisplayedData()
void	setContentPane(Container contentPane)
void	setDataConverterFunction(Function<JIPipeVirtualData,JIPipeVirtualData> dataConverterFunction)
void	setDataSourceRow(int row)
protected void	showErrorUI() Instruction to add the error UI By default, it will update the standard error label and revalidate the toolbar

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

JIPipeCacheDataViewerWindow

public JIPipeCacheDataViewerWindow(JIPipeWorkbench workbench,
                                   JIPipeDataTableDataSource dataSource,
                                   String displayName)

Method Detail

getStandardErrorLabel

public JLabel getStandardErrorLabel()

Returns a standard error label that simplifies the creation of cache windows. It must be included into the UI manually

Returns:

the standard error label

getContentPane

public Container getContentPane()

Specified by:

getContentPane in interface RootPaneContainer

Overrides:

getContentPane in class JFrame

setContentPane

public void setContentPane(Container contentPane)

Specified by:

setContentPane in interface RootPaneContainer

Overrides:

setContentPane in class JFrame

gotoNextRow

public void gotoNextRow()

reloadDisplayedData

public void reloadDisplayedData()

setDataSourceRow

public void setDataSourceRow(int row)

getPinToolBar

public JToolBar getPinToolBar()

The toolbar where the window pin controls are added. Defaults to getToolBar(). For FlexContentPanel, return getPinToolBar();

Returns:

the pin toolbar

getToolBar

public abstract JToolBar getToolBar()

Returns the toolbar that contains

Returns:

the toolbar

beforeSetRow

protected abstract void beforeSetRow()

Called before the data row is changed

afterSetRow

protected abstract void afterSetRow()

Called after the data row was changed

hideErrorUI

protected void hideErrorUI()

Instruction to remove the error UI By default, it will hide the standard error label

showErrorUI

protected void showErrorUI()

Instruction to add the error UI By default, it will update the standard error label and revalidate the toolbar

loadData

protected abstract void loadData(JIPipeVirtualData virtualData,
                                 JIPipeProgressInfo progressInfo)

Instruction to load the data from the current data source

Parameters:

virtualData - the data to be loaded

progressInfo - the progress info

getAlgorithm

public JIPipeAlgorithm getAlgorithm()

getProject

public JIPipeProject getProject()

getDataSource

public JIPipeDataTableDataSource getDataSource()

getWorkbench

public JIPipeWorkbench getWorkbench()

getSlotName

public String getSlotName()

onCacheUpdated

public void onCacheUpdated(JIPipeProjectCache.ModifiedEvent event)

getDisplayName

public String getDisplayName()

getDataConverterFunction

public Function<JIPipeVirtualData,JIPipeVirtualData> getDataConverterFunction()

setDataConverterFunction

public void setDataConverterFunction(Function<JIPipeVirtualData,JIPipeVirtualData> dataConverterFunction)