Package nz.ac.waikato.cms.gui.core

Class BaseTextPaneWithWordWrap

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nz.ac.waikato.cms.gui.core.BasePanel

nz.ac.waikato.cms.gui.core.BaseTextPaneWithWordWrap

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, TextPaneComponent

public class BaseTextPaneWithWordWrap
extends BasePanel
implements TextPaneComponent

A panel containing a BaseTextPane, to allow wordwrap functionality.

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 JPanel	m_PanelWrapper	the wrapper panel.
protected BaseScrollPane	m_ScrollPane	the scroll pane.
protected BaseTextPane	m_TextPane	the wrapped text pane.
protected boolean	m_WordWrap	whether wordwrap is on.

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
BaseTextPaneWithWordWrap()

Method Summary

Modifier and Type	Method	Description
void	append(String text)	Appends the text at the end.
void	append(String text, AttributeSet a)	Appends the text at the end.
int	getCaretPosition()	Returns the current position of the cursor.
Document	getDocument()	Returns the underlying document.
String	getSelectedText()	Returns the underlying text.
String	getText()	Returns the text to display.
BaseTextPane	getTextPane()	Returns the underlying BaseTextPane.
boolean	getWordWrap()	Returns whether wordwrap is on.
protected void	initGUI()	For initializing the GUI.
protected void	initialize()	Initializes the members.
boolean	isEditable()	Returns whether the text pane is editable or not.
void	setCaretPosition(int value)	Sets the position of the cursor.
void	setCaretPositionLast()	Sets the position of the cursor at the end.
void	setEditable(boolean value)	Sets whether the text pane is editable or not.
void	setText(String value)	Sets the text to display.
void	setWordWrap(boolean value)	Sets the wordwrap state.

Methods inherited from class nz.ac.waikato.cms.gui.core.BasePanel

finishInit

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

m_TextPane

protected BaseTextPane m_TextPane

the wrapped text pane.

m_PanelWrapper

protected JPanel m_PanelWrapper

the wrapper panel.

m_ScrollPane

protected BaseScrollPane m_ScrollPane

the scroll pane.

m_WordWrap

protected boolean m_WordWrap

whether wordwrap is on.

Constructor Details

BaseTextPaneWithWordWrap

public BaseTextPaneWithWordWrap()

Method Details

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

For initializing the GUI.

Overrides:

initGUI in class BasePanel

getTextPane

public BaseTextPane getTextPane()

Returns the underlying BaseTextPane.

Returns:

the pane

setText

public void setText(String value)

Sets the text to display.

Specified by:

setText in interface TextPaneComponent

Parameters:

value - the text

getText

public String getText()

Returns the text to display.

Specified by:

getText in interface TextPaneComponent

Returns:

the text

getSelectedText

public String getSelectedText()

Returns the underlying text.

Specified by:

getSelectedText in interface TextPaneComponent

Returns:

the underlying text

setEditable

public void setEditable(boolean value)

Sets whether the text pane is editable or not.

Specified by:

setEditable in interface TextPaneComponent

Parameters:

value - if true the text pane is editable

isEditable

public boolean isEditable()

Returns whether the text pane is editable or not.

Specified by:

isEditable in interface TextPaneComponent

Returns:

true if the text pane is editable

getDocument

public Document getDocument()

Returns the underlying document.

Specified by:

getDocument in interface TextPaneComponent

Returns:

the document

setWordWrap

public void setWordWrap(boolean value)

Sets the wordwrap state.

Parameters:

value - true if to turn wordwrap on

getWordWrap

public boolean getWordWrap()

Returns whether wordwrap is on.

Returns:

true if wordwrap is on

append

public void append(String text)

Appends the text at the end.

Parameters:

text - the text to append

append

public void append(String text,
 AttributeSet a)

Appends the text at the end.

Parameters:

text - the text to append

a - the attribute set, null if to use current

setCaretPosition

public void setCaretPosition(int value)

Sets the position of the cursor.

Specified by:

setCaretPosition in interface TextPaneComponent

Parameters:

value - the position

getCaretPosition

public int getCaretPosition()

Returns the current position of the cursor.

Specified by:

getCaretPosition in interface TextPaneComponent

Returns:

the cursor position

setCaretPositionLast

public void setCaretPositionLast()

Sets the position of the cursor at the end.

Specified by:

setCaretPositionLast in interface TextPaneComponent