org.embl.ebi.escience.scuflui
Class ScuflSemanticMarkupEditor

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.embl.ebi.escience.scuflui.ScuflSemanticMarkupEditor

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, SemanticMarkupViewSPI, UIComponentSPI

public class ScuflSemanticMarkupEditor
extends javax.swing.JPanel
implements SemanticMarkupViewSPI

A JPanel that allows editing of the semantic markup object passed into its constructor.

Author:

Tom Oinn

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JComponent.AccessibleJComponent

Field Summary

Fields inherited from class javax.swing.JComponent

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

ScuflSemanticMarkupEditor()
Construct a blank semantic markup editor with no model object assigned

ScuflSemanticMarkupEditor(SemanticMarkup m)
Build a new markup editor attached to the particular SemanticMarkup object.

Method Summary

void	attachToModel(SemanticMarkup theModel) Directs the implementing component to bind to the specified SemanticMarkup instance, refresh its internal state from the model and commence listening to events, maintaining its state as these events dictate.
void	detachFromModel() Directs the implementing component to detach from the model, set its internal state to some suitable blank (i.e.
void	expandAll(javax.swing.JTree tree, boolean expand)
javax.swing.ImageIcon	getIcon() Get an icon to be used in window decorations for this component.
java.lang.String	getName() Get the preferred name of this component, for titles in windows etc.
javax.swing.tree.TreeCellRenderer	getRenderer(java.lang.String searchRegex) If the 'searchRegex' parameter is not null then choose the icon based on whether a regex match exists between the string and the toString method on the user object within the tree
void	onDisplay() Called when the component is displayed in the UI
void	onDispose() Called after the component has been removed from the UI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScuflSemanticMarkupEditor

public ScuflSemanticMarkupEditor()

Construct a blank semantic markup editor with no model object assigned

ScuflSemanticMarkupEditor

public ScuflSemanticMarkupEditor(SemanticMarkup m)

Build a new markup editor attached to the particular SemanticMarkup object.

Method Detail

getIcon

public javax.swing.ImageIcon getIcon()

Description copied from interface: UIComponentSPI

Get an icon to be used in window decorations for this component.

Specified by:

getIcon in interface UIComponentSPI

attachToModel

public void attachToModel(SemanticMarkup theModel)

Description copied from interface: SemanticMarkupViewSPI

Directs the implementing component to bind to the specified SemanticMarkup instance, refresh its internal state from the model and commence listening to events, maintaining its state as these events dictate.

Specified by:

attachToModel in interface SemanticMarkupViewSPI

detachFromModel

public void detachFromModel()

Description copied from interface: SemanticMarkupViewSPI

Directs the implementing component to detach from the model, set its internal state to some suitable blank (i.e. blank image, no text in a text field etc) and desist from listening to model events.

Specified by:

detachFromModel in interface SemanticMarkupViewSPI

getName

public java.lang.String getName()

Description copied from interface: UIComponentSPI

Get the preferred name of this component, for titles in windows etc.

Specified by:

getName in interface UIComponentSPI

Overrides:

getName in class java.awt.Component

getRenderer

public javax.swing.tree.TreeCellRenderer getRenderer(java.lang.String searchRegex)

If the 'searchRegex' parameter is not null then choose the icon based on whether a regex match exists between the string and the toString method on the user object within the tree

expandAll

public void expandAll(javax.swing.JTree tree,
                      boolean expand)

onDisplay

public void onDisplay()

Description copied from interface: UIComponentSPI

Called when the component is displayed in the UI

Specified by:

onDisplay in interface UIComponentSPI

onDispose

public void onDispose()

Description copied from interface: UIComponentSPI

Called after the component has been removed from the UI

Specified by:

onDispose in interface UIComponentSPI