com.rapidminer.gui
Class OperatorDocViewer

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.rapidminer.gui.OperatorDocViewer

All Implemented Interfaces:

ProcessEditor, com.vlsolutions.swing.docking.Dockable, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

OperatorDocEditor

public class OperatorDocViewer
extends javax.swing.JPanel
implements com.vlsolutions.swing.docking.Dockable, ProcessEditor

Displays HTML help text for an operator

Author:

Simon Fischer

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String

OPERATOR_HELP_DOCK_KEY

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

OperatorDocViewer()

Method Summary

java.awt.Component	getComponent()
OperatorDocViewer	getCurrentOperatorDocViewerObject()
Operator	getDisplayedOperator()
java.lang.String	getDisplayedOperatorDescName()
com.vlsolutions.swing.docking.DockKey	getDockKey()
javax.swing.JEditorPane	getEditor()
ShowHelpTextAction	getShowHelpTextAction()
static OperatorDocViewer	instantiate()
protected java.lang.String	makeDescriptionHeader()
protected static java.lang.Object	makeExampleFooter(int exampleIndex)
protected static java.lang.String	makeOperatorDocumentation(Operator displayedOperator)
protected static java.lang.String	makeParameterHeader(ParameterType type)
protected java.lang.String	makeSynopsisHeader()
void	processChanged(Process process) Notifies the component that the entire process has changed.
void	processUpdated(Process process) Notifies the component that process was updated in some way.
void	refresh()
void	setDisplayedOperator(Operator operator)
void	setSelection(java.util.List<Operator> selection) Sets the currently selected operator.
protected void	showHelptext()
void	showLoadScreen()

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR_HELP_DOCK_KEY

public static final java.lang.String OPERATOR_HELP_DOCK_KEY

See Also:

Constant Field Values

Constructor Detail

OperatorDocViewer

public OperatorDocViewer()

Method Detail

getDisplayedOperatorDescName

public java.lang.String getDisplayedOperatorDescName()

getEditor

public javax.swing.JEditorPane getEditor()

getDisplayedOperator

public Operator getDisplayedOperator()

getCurrentOperatorDocViewerObject

public OperatorDocViewer getCurrentOperatorDocViewerObject()

setDisplayedOperator

public void setDisplayedOperator(Operator operator)

showHelptext

protected void showHelptext()

makeOperatorDocumentation

protected static java.lang.String makeOperatorDocumentation(Operator displayedOperator)

makeExampleFooter

protected static java.lang.Object makeExampleFooter(int exampleIndex)

makeSynopsisHeader

protected java.lang.String makeSynopsisHeader()

makeDescriptionHeader

protected java.lang.String makeDescriptionHeader()

makeParameterHeader

protected static java.lang.String makeParameterHeader(ParameterType type)

setSelection

public void setSelection(java.util.List<Operator> selection)

Description copied from interface: ProcessEditor

Sets the currently selected operator.

Specified by:

setSelection in interface ProcessEditor

getComponent

public java.awt.Component getComponent()

Specified by:

getComponent in interface com.vlsolutions.swing.docking.Dockable

getDockKey

public com.vlsolutions.swing.docking.DockKey getDockKey()

Specified by:

getDockKey in interface com.vlsolutions.swing.docking.Dockable

processChanged

public void processChanged(Process process)

Description copied from interface: ProcessEditor

Notifies the component that the entire process has changed.

Specified by:

processChanged in interface ProcessEditor

processUpdated

public void processUpdated(Process process)

Description copied from interface: ProcessEditor

Notifies the component that process was updated in some way.

Specified by:

processUpdated in interface ProcessEditor

instantiate

public static OperatorDocViewer instantiate()

getShowHelpTextAction

public ShowHelpTextAction getShowHelpTextAction()

showLoadScreen

public void showLoadScreen()

refresh

public void refresh()