Package adams.gui.core

Class MarkdownTextAreaWithPreview

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.MarkdownTextAreaWithPreview

All Implemented Interfaces:

adams.gui.core.BaseTextComponent, adams.gui.core.TextAreaComponent, ImageObserver, MenuContainer, Serializable, Accessible

public class MarkdownTextAreaWithPreview
extends adams.gui.core.BasePanel
implements adams.gui.core.TextAreaComponent

Text area for handling Markdown with code and preview tabs.

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 adams.gui.core.BaseHtmlEditorPane	m_PanePreview	the preview.
protected org.markdownj.MarkdownProcessor	m_Processor	the markdown processor.
protected adams.gui.core.BaseTabbedPane	m_TabbedPane	the tabbed pane.
protected adams.gui.core.BaseTextArea	m_TextCode	the text area for writing markdown code.

Fields inherited from class adams.gui.core.BasePanel

m_FileChooser

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

Method Summary

Modifier and Type	Method	Description
int	getCaretPosition()	Returns the current caret position.
int	getColumns()	Returns the columns.
Document	getDocument()	Returns the underlying document.
boolean	getLineWrap()	Returns whether line wrap is enabled.
int	getRows()	Returns the rows.
String	getSelectedText()	Returns the underlying text.
String	getText()	Returns the markdown code to display.
Font	getTextFont()	Returns the text font in use.
boolean	getWrapStyleWord()	Returns whether word wrap is enabled.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
boolean	isEditable()	Returns whether the text area is editable or not.
static void	main(String[] args)	For testing only.
void	setCaretPosition(int pos)	Sets the caret position.
void	setCaretPositionLast()	Sets the position of the cursor at the end.
void	setColumns(int value)	Sets the columns.
void	setEditable(boolean value)	Sets whether the text area is editable or not.
void	setLineWrap(boolean value)	Sets whether to line wrap or not.
void	setRows(int value)	Sets the rows.
void	setText(String value)	Sets the markdown code to display.
void	setTextFont(Font value)	Sets the text font.
void	setWrapStyleWord(boolean value)	Sets whether to word wrap or not.
protected void	update()	Updates the markdown display.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, finishInit, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initFileChooser, printErrorMessage, printException, saveComponent, 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_TabbedPane

protected adams.gui.core.BaseTabbedPane m_TabbedPane

the tabbed pane.

m_TextCode

protected adams.gui.core.BaseTextArea m_TextCode

the text area for writing markdown code.

m_PanePreview

protected adams.gui.core.BaseHtmlEditorPane m_PanePreview

the preview.

m_Processor

protected org.markdownj.MarkdownProcessor m_Processor

the markdown processor.

Constructor Detail

MarkdownTextAreaWithPreview

public MarkdownTextAreaWithPreview()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class adams.gui.core.BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class adams.gui.core.BasePanel

setText

public void setText(String value)

Sets the markdown code to display.

Specified by:

setText in interface adams.gui.core.BaseTextComponent

Specified by:

setText in interface adams.gui.core.TextAreaComponent

Parameters:

value - the markdown code

getText

public String getText()

Returns the markdown code to display.

Specified by:

getText in interface adams.gui.core.BaseTextComponent

Specified by:

getText in interface adams.gui.core.TextAreaComponent

Returns:

the markdown code

getDocument

public Document getDocument()

Returns the underlying document.

Specified by:

getDocument in interface adams.gui.core.TextAreaComponent

Returns:

the document

getSelectedText

public String getSelectedText()

Returns the underlying text.

Specified by:

getSelectedText in interface adams.gui.core.TextAreaComponent

Returns:

the underlying text

setRows

public void setRows(int value)

Sets the rows.

Specified by:

setRows in interface adams.gui.core.TextAreaComponent

Parameters:

value - the rows

getRows

public int getRows()

Returns the rows.

Specified by:

getRows in interface adams.gui.core.TextAreaComponent

Returns:

the rows

setColumns

public void setColumns(int value)

Sets the columns.

Specified by:

setColumns in interface adams.gui.core.TextAreaComponent

Parameters:

value - the columns

getColumns

public int getColumns()

Returns the columns.

Specified by:

getColumns in interface adams.gui.core.TextAreaComponent

Returns:

the columns

setEditable

public void setEditable(boolean value)

Sets whether the text area is editable or not.

Specified by:

setEditable in interface adams.gui.core.TextAreaComponent

Parameters:

value - if true the text area is editable

isEditable

public boolean isEditable()

Returns whether the text area is editable or not.

Specified by:

isEditable in interface adams.gui.core.TextAreaComponent

Returns:

true if the text area is editable

setLineWrap

public void setLineWrap(boolean value)

Sets whether to line wrap or not.

Specified by:

setLineWrap in interface adams.gui.core.TextAreaComponent

Parameters:

value - if true line wrap is enabled

getLineWrap

public boolean getLineWrap()

Returns whether line wrap is enabled.

Specified by:

getLineWrap in interface adams.gui.core.TextAreaComponent

Returns:

true if line wrap wrap is enabled

setWrapStyleWord

public void setWrapStyleWord(boolean value)

Sets whether to word wrap or not.

Specified by:

setWrapStyleWord in interface adams.gui.core.TextAreaComponent

Parameters:

value - if true word wrap is enabled

getWrapStyleWord

public boolean getWrapStyleWord()

Returns whether word wrap is enabled.

Specified by:

getWrapStyleWord in interface adams.gui.core.TextAreaComponent

Returns:

true if word wrap wrap is enabled

setTextFont

public void setTextFont(Font value)

Sets the text font.

Specified by:

setTextFont in interface adams.gui.core.TextAreaComponent

Parameters:

value - the font

getTextFont

public Font getTextFont()

Returns the text font in use.

Specified by:

getTextFont in interface adams.gui.core.TextAreaComponent

Returns:

the font

setCaretPosition

public void setCaretPosition(int pos)

Sets the caret position.

Specified by:

setCaretPosition in interface adams.gui.core.TextAreaComponent

Parameters:

pos - the position (0-based)

getCaretPosition

public int getCaretPosition()

Returns the current caret position.

Specified by:

getCaretPosition in interface adams.gui.core.TextAreaComponent

Returns:

the position (0-based)

setCaretPositionLast

public void setCaretPositionLast()

Sets the position of the cursor at the end.

Specified by:

setCaretPositionLast in interface adams.gui.core.TextAreaComponent

update

protected void update()

Updates the markdown display.

main

public static void main(String[] args)

For testing only.

Parameters:

args - ignored