Package adams.gui.tools.wekainvestigator.output

Class TextualContentPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.DetachablePanel

adams.gui.tools.wekainvestigator.output.AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>

adams.gui.tools.wekainvestigator.output.TextualContentPanel

All Implemented Interfaces:

adams.core.CleanUpHandler, adams.core.TextSupporter, adams.gui.core.PopupMenuProvider, ImageObserver, MenuContainer, Serializable, Accessible

public class TextualContentPanel
extends AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>
implements adams.core.TextSupporter

Panel for exporting the textual component as text.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

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	Description
protected JComponent	m_Component	the actual component.

Fields inherited from class adams.gui.tools.wekainvestigator.output.AbstractOutputPanelWithPopupMenu

m_FileChooser

Fields inherited from class adams.gui.core.DetachablePanel

DETACH_ICON, m_ButtonReattach, m_ContentPanel, m_DetachedFrame, m_DetachListeners, m_FrameTitle, m_LastFramePosition, m_LastFrameSize, m_PanelReattach, m_PopupMenuCustomizer, m_ReattachListeners, REATTACH_ICON

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	Description
TextualContentPanel(adams.gui.core.BaseTextAreaWithButtons comp, boolean useScrollPane)	Initializes the panel with the specified textual component.
TextualContentPanel(adams.gui.core.BaseTextPaneWithButtons comp, boolean useScrollPane)	Initializes the panel with the specified textual component.
TextualContentPanel(JTextComponent comp, boolean useScrollPane)	Initializes the panel with the specified textual component.

Method Summary

Modifier and Type	Method	Description
boolean	canCopyToClipboard()	Returns whether copying to the clipboard is supported.
void	copyToClipboard()	Copies the content to the clipboard.
protected adams.gui.chooser.TextFileChooser	createFileChooser()	Creates the filechooser to use.
JComponent	getComponent()	Returns the embedded component.
protected void	initGUI(JComponent comp, boolean useScrollPane)	Initializes the panel with the specified component.
protected String	save(File file)	Saves the content to the specified file.
String	supplyText()	Supplies the text.

Methods inherited from class adams.gui.tools.wekainvestigator.output.AbstractOutputPanelWithPopupMenu

createPopupMenu, getFileChooser, initialize, save

Methods inherited from class adams.gui.core.DetachablePanel

addDetachListener, addReattachListener, cleanUp, clearDetachListeners, clearReattachListeners, detach, getContentPanel, getFrameTitle, getPopupMenu, getPopupMenuCustomizer, initGUI, isDetached, notifyDetachListeners, notifyReattachListeners, reattach, removeDetachListener, removeReattachListener, setFrameTitle, setPopupMenuCustomizer

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

m_Component

protected JComponent m_Component

the actual component.

Constructor Detail

TextualContentPanel

public TextualContentPanel(JTextComponent comp,
                           boolean useScrollPane)

Initializes the panel with the specified textual component.

Parameters:

comp - the component to embed

useScrollPane - whether to use a scroll pane

TextualContentPanel

public TextualContentPanel(adams.gui.core.BaseTextAreaWithButtons comp,
                           boolean useScrollPane)

Initializes the panel with the specified textual component.

Parameters:

comp - the component to embed

useScrollPane - whether to use a scroll pane

TextualContentPanel

public TextualContentPanel(adams.gui.core.BaseTextPaneWithButtons comp,
                           boolean useScrollPane)

Initializes the panel with the specified textual component.

Parameters:

comp - the component to embed

useScrollPane - whether to use a scroll pane

Method Detail

initGUI

protected void initGUI(JComponent comp,
                       boolean useScrollPane)

Initializes the panel with the specified component.

Parameters:

comp - the component to embed

useScrollPane - whether to use a scroll pane

getComponent

public JComponent getComponent()

Returns the embedded component.

Returns:

the component

createFileChooser

protected adams.gui.chooser.TextFileChooser createFileChooser()

Creates the filechooser to use.

Specified by:

createFileChooser in class AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>

Returns:

the filechooser

save

protected String save(File file)

Saves the content to the specified file.

Specified by:

save in class AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>

Parameters:

file - the file to save to

Returns:

null if successful, otherwise error message

supplyText

public String supplyText()

Supplies the text.

Specified by:

supplyText in interface adams.core.TextSupporter

Returns:

the text, null if none available

canCopyToClipboard

public boolean canCopyToClipboard()

Returns whether copying to the clipboard is supported.

Overrides:

canCopyToClipboard in class AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>

Returns:

true if copy to clipboard is supported

See Also:

copyToClipboard()

copyToClipboard

public void copyToClipboard()

Copies the content to the clipboard.

Overrides:

copyToClipboard in class AbstractOutputPanelWithPopupMenu<adams.gui.chooser.TextFileChooser>

See Also:

canCopyToClipboard()