at.tuwien.ifs.somtoolbox.apps.viewer

Class DocViewPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

at.tuwien.ifs.somtoolbox.apps.viewer.DocViewPanel

All Implemented Interfaces:

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

public class DocViewPanel
extends javax.swing.JPanel
implements ItemSelectionListener

This class represents the panel for the viewing documents.
It has an EditorPane for viewing HTML documents.

Version:

$Id: DocViewPanel.java 4363 2015-03-11 17:30:06Z mayer $

Author:

Rudolf Mayer

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

Fields

Modifier and Type	Field and Description
private java.lang.String	currentInput
private java.lang.String	documentPath
private java.lang.String	documentSuffix
private javax.swing.text.Highlighter	highlighter
private SharedSOMVisualisationData	inputDataObjects
private org.apache.commons.logging.Log	log
private PaletteSelectionPanel	paletteSelectionPanel
private java.util.ArrayList<java.lang.Object>	searchResultHighLights
private static long	serialVersionUID
private javax.swing.JEditorPane	textPane
private javax.swing.JTextField	txtFieldSearch
private javax.swing.JCheckBox	weightHighlightBox
private java.util.ArrayList<java.lang.Object>	weightingHighLights
private javax.swing.text.DefaultHighlighter.DefaultHighlightPainter[]	weightPaints

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
DocViewPanel(SharedSOMVisualisationData inputDataObjects)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocumentPath()
java.lang.String	getDocumentSuffix()
void	itemSelected(java.lang.Object[] items) displays the document with the provided name in the docviewer.
private double	relativeValue(double minValue, double span, double value)
private void	removeHighLights(java.util.ArrayList<java.lang.Object> highLights)
void	setDocumentPath(java.lang.String filePath)
void	setDocumentSuffix(java.lang.String documentSuffix)
private void	updateSearchResults()
private void	updateWeightHighlighting()
private void	updateWeightHighlighting(java.lang.Object[] items)

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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

log

private org.apache.commons.logging.Log log

textPane

private javax.swing.JEditorPane textPane

highlighter

private javax.swing.text.Highlighter highlighter

txtFieldSearch

private javax.swing.JTextField txtFieldSearch

searchResultHighLights

private java.util.ArrayList<java.lang.Object> searchResultHighLights

weightHighlightBox

private javax.swing.JCheckBox weightHighlightBox

weightingHighLights

private java.util.ArrayList<java.lang.Object> weightingHighLights

paletteSelectionPanel

private PaletteSelectionPanel paletteSelectionPanel

documentPath

private java.lang.String documentPath

documentSuffix

private java.lang.String documentSuffix

inputDataObjects

private SharedSOMVisualisationData inputDataObjects

weightPaints

private javax.swing.text.DefaultHighlighter.DefaultHighlightPainter[] weightPaints

currentInput

private java.lang.String currentInput

Constructor Detail

DocViewPanel

public DocViewPanel(SharedSOMVisualisationData inputDataObjects)

Method Detail

getDocumentSuffix

public java.lang.String getDocumentSuffix()

setDocumentSuffix

public void setDocumentSuffix(java.lang.String documentSuffix)

getDocumentPath

public java.lang.String getDocumentPath()

setDocumentPath

public void setDocumentPath(java.lang.String filePath)

itemSelected

public void itemSelected(java.lang.Object[] items)

displays the document with the provided name in the docviewer. If not existent, the text is cleared.
NOTE: we are only caring about the first item, because we can only display one document at a time. We assume that the listselectionode in the panel is set to singleselection

Specified by:

itemSelected in interface ItemSelectionListener

removeHighLights

private void removeHighLights(java.util.ArrayList<java.lang.Object> highLights)

updateSearchResults

private void updateSearchResults()

updateWeightHighlighting

private void updateWeightHighlighting(java.lang.Object[] items)

updateWeightHighlighting

private void updateWeightHighlighting()

relativeValue

private double relativeValue(double minValue,
                             double span,
                             double value)