org.mdi.gui.swing

Class DefaultMessageArea

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.mdi.gui.swing.DefaultMessageArea

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, MessageLogger, MessageArea<java.awt.Component>, SwingMessageArea

public class DefaultMessageArea
extends javax.swing.JPanel
implements SwingMessageArea

Presents a scrollable text area for user messages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultMessageArea.HtmlSelection

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
protected StylableSizableArea	area The stylable area.
protected javax.swing.AbstractAction	clearAction The clear action.
protected javax.swing.AbstractAction	copyAction The copy to clipboard action.
static int	DEFAULT_ROWS Default height of the Message Area.
protected javax.swing.text.html.HTMLDocument	doc The HTMLDocument used by the area.
protected javax.swing.JFrame	frame The parent frame.
protected java.util.List<MessageAreaHandler>	handlers The message area handler.
protected static java.util.regex.Pattern	HYPERLINK_PAT
protected boolean	hyperLinkActivated True if the hyperlink was activated.
protected javax.swing.text.html.HTMLEditorKit	kit The editor kit.
protected javax.swing.AbstractAction	printAction The print action.
protected javax.swing.AbstractAction	saveAction The save action.

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 org.mdi.gui.MessageArea

DEFAULT_MAXIMUM_LINES

Fields inherited from interface org.mdi.bootstrap.MessageLogger

BOLD, CROSSED, DEFAULT_FONT_SIZE, DEFAULT_STYLE, ITALIC, UNDERLINE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DefaultMessageArea() Create a new MessageArea.
DefaultMessageArea(java.awt.Component parent) Create a new MessageArea, with a default number of rows.
DefaultMessageArea(java.awt.Component parent, int rows) Create a new MessageArea.
DefaultMessageArea(java.awt.Component parent, int rows, boolean isEditableMessageArea) Create a new MessageArea.

Method Summary

Modifier and Type	Method and Description
void	addHandler(MessageAreaHandler handler) Add the handler which will be fired after Hyperlink selections in the area.
void	append(java.lang.String txt) Append a line of text in the message area.
void	append(java.lang.String txt, long time) Append a line of text in the message area.
void	append(java.lang.String txt, java.lang.String htmlColor) Append a line of text in the message area.
void	append(java.lang.String txt, java.lang.String htmlColor, int fontSize, int style) Append a line of text in the message area.
void	appendLink(java.lang.String txt, java.lang.String linkID) Append a line of text with an hyperlink in the message area.
void	appendLink(java.lang.String txt, java.lang.String linkID, java.lang.Object o) Append a line of text with an hyperlink in the message area.The link can be any text without space, and can be used as desired by the application.
void	appendLink(java.lang.String txt, java.lang.String linkID, java.lang.String htmlColor) Append a line of text with an hyperlink in the message area.
void	appendLink(java.lang.String txt, java.lang.String linkID, java.lang.String htmlColor, int fontSize, int style) Append a line of text with an hyperlink in the message area.
void	appendLink(java.lang.String txt, java.lang.String linkID, java.lang.String htmlColor, java.lang.Object o) Append a line of text with an hyperlink in the message area.
protected void	appendText(java.lang.String text) Append a line of text, considering the possible number of lines limitation.
void	clear() Clear the content of the message area and resize it accordingly.
void	copyToClipboard() Copy the hightlighted text to the system clipboard.
int	getMaximumLines() Return the maximum lines to be displayed, or -1 if there is no limitation.
MessageAreaHandler	getMessageAreaHandler() Return the first message area handler.
java.util.List<MessageAreaHandler>	getMessageAreaHandlers() Return the message area handlers.
boolean	hasMaximumLines() Return true if the number of lines to be displayed is limited.
protected boolean	hasSelectedText() Return true if some text has been highlighted.
protected void	initDocument() Initialize the document.
protected void	initializeHTMLContent(int rows) Initialize the HTML content.
protected void	initializePopupMenu() Initialize the Popup menu.
boolean	isHandlingRightClick() Return true if the message area is handling right clicks.
boolean	isManagingClipBoard() True if the area is managing the clipboard.
boolean	isSavingAreaLines() Return true if there is a popup menu action to save the lines as text.
void	manageClipBoard(boolean manageClipboard) Set if the area is managing the clipboard.
protected void	print() Called when the "print" action is called.
void	print(java.io.File file) Print the content of the area in a html file.
protected void	resize() Resize the area.
protected void	save() Called when the "save" action is called.
void	save(java.io.File file) Save the content of the area in a file.
void	saveAreaLines(boolean save) Set if there is a popup menu action to save the lines as text.
void	setHandler(MessageAreaHandler handler) Deprecated.
void	setHandleRightClick(boolean isHandlingRightClick) Set if the message area is handling right clicks.
void	setMaximumLines(int maximumLines) Set the maximum of lines which are accepted in this message Area.
void	setMaximumLinesBehavior(boolean hasMaximumLines) Set the behavior concerning the maximum number of lines which are accepted in this message Area.
void	setParent(java.awt.Component parent, int rows) Set the parent component
void	setStyleSheet(javax.swing.text.html.StyleSheet styleSheet) Set the StyleSheet used on the document.
protected void	showPopupMenu(int x, int y) Create the message area Popup menu.

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

Methods inherited from interface org.mdi.gui.MessageArea

getHandler, isEditable

Methods inherited from interface org.mdi.bootstrap.MessageLogger

appendError

Field Detail

area

protected StylableSizableArea area

The stylable area.

doc

protected javax.swing.text.html.HTMLDocument doc

The HTMLDocument used by the area.

kit

protected javax.swing.text.html.HTMLEditorKit kit

The editor kit.

frame

protected javax.swing.JFrame frame

The parent frame.

hyperLinkActivated

protected boolean hyperLinkActivated

True if the hyperlink was activated.

handlers

protected java.util.List<MessageAreaHandler> handlers

The message area handler.

HYPERLINK_PAT

protected static final java.util.regex.Pattern HYPERLINK_PAT

clearAction

protected javax.swing.AbstractAction clearAction

The clear action.

copyAction

protected javax.swing.AbstractAction copyAction

The copy to clipboard action.

printAction

protected javax.swing.AbstractAction printAction

The print action.

saveAction

protected javax.swing.AbstractAction saveAction

The save action.

DEFAULT_ROWS

public static final int DEFAULT_ROWS

Default height of the Message Area.

See Also:

Constant Field Values

Constructor Detail

DefaultMessageArea

public DefaultMessageArea()

Create a new MessageArea.

DefaultMessageArea

public DefaultMessageArea(java.awt.Component parent)

Create a new MessageArea, with a default number of rows.

Parameters:

parent - the parent

DefaultMessageArea

public DefaultMessageArea(java.awt.Component parent,
                          int rows)

Create a new MessageArea.

Parameters:

parent - the parent component

rows - the number of rows of this area

DefaultMessageArea

public DefaultMessageArea(java.awt.Component parent,
                          int rows,
                          boolean isEditableMessageArea)

Create a new MessageArea.

Parameters:

parent - the parent component

rows - the number of rows of this area

isEditableMessageArea - true if the message area is editable

Method Detail

saveAreaLines

public void saveAreaLines(boolean save)

Set if there is a popup menu action to save the lines as text.

Specified by:

saveAreaLines in interface SwingMessageArea

Parameters:

save - true if there is a popup menu action to save the lines as text

isSavingAreaLines

public boolean isSavingAreaLines()

Return true if there is a popup menu action to save the lines as text.

Specified by:

isSavingAreaLines in interface SwingMessageArea

Returns:

true if there is a popup menu action to save the lines as text

addHandler

public void addHandler(MessageAreaHandler handler)

Add the handler which will be fired after Hyperlink selections in the area.

Specified by:

addHandler in interface MessageArea<java.awt.Component>

Parameters:

handler - the handler

setHandler

@Deprecated
public void setHandler(MessageAreaHandler handler)

Deprecated.

Set the handler which will be fired after Hyperlink selections in the area.

Specified by:

setHandler in interface MessageArea<java.awt.Component>

Parameters:

handler - the handler

getMessageAreaHandler

public MessageAreaHandler getMessageAreaHandler()

Return the first message area handler.

Specified by:

getMessageAreaHandler in interface MessageArea<java.awt.Component>

Returns:

the handler

getMessageAreaHandlers

public java.util.List<MessageAreaHandler> getMessageAreaHandlers()

Return the message area handlers.

Specified by:

getMessageAreaHandlers in interface MessageArea<java.awt.Component>

Returns:

the handlers

manageClipBoard

public void manageClipBoard(boolean manageClipboard)

Set if the area is managing the clipboard.

Specified by:

manageClipBoard in interface MessageArea<java.awt.Component>

Parameters:

manageClipboard - true if the area is managing the clipboard

isManagingClipBoard

public boolean isManagingClipBoard()

True if the area is managing the clipboard.

Specified by:

isManagingClipBoard in interface MessageArea<java.awt.Component>

Returns:

true if the area is managing the clipboard

setHandleRightClick

public void setHandleRightClick(boolean isHandlingRightClick)

Set if the message area is handling right clicks.

Specified by:

setHandleRightClick in interface SwingMessageArea

Parameters:

isHandlingRightClick - if the message area is handling right clicks

isHandlingRightClick

public boolean isHandlingRightClick()

Return true if the message area is handling right clicks.

Specified by:

isHandlingRightClick in interface MessageArea<java.awt.Component>

Returns:

true if the message area is handling right clicks

setMaximumLines

public void setMaximumLines(int maximumLines)

Set the maximum of lines which are accepted in this message Area. If the number is equal to -1, there is no limitation (default). If there is a maximum number of lines, the first lines will be removed from the area as new lines appear, as in a FIFO pile.

Specified by:

setMaximumLines in interface MessageArea<java.awt.Component>

Parameters:

maximumLines - the maximum of lines

setMaximumLinesBehavior

public void setMaximumLinesBehavior(boolean hasMaximumLines)

Set the behavior concerning the maximum number of lines which are accepted in this message Area.

• setting the behavior to true is a shortcut to setMaximumLines(int) with a value of 500 lines
• setting the behavior to true is a shortcut to setMaximumLines(int) with a value of -1

Specified by:

setMaximumLinesBehavior in interface MessageArea<java.awt.Component>

Parameters:

hasMaximumLines - true if the number of lines to be displayed is limited

getMaximumLines

public int getMaximumLines()

Return the maximum lines to be displayed, or -1 if there is no limitation.

Specified by:

getMaximumLines in interface MessageArea<java.awt.Component>

Returns:

the maximum lines to be displayed, or -1 if there is no limitation

hasMaximumLines

public boolean hasMaximumLines()

Return true if the number of lines to be displayed is limited.

Specified by:

hasMaximumLines in interface MessageArea<java.awt.Component>

Returns:

true if the number of lines to be displayed is limited

initializePopupMenu

protected void initializePopupMenu()

Initialize the Popup menu.

setParent

public void setParent(java.awt.Component parent,
                      int rows)

Set the parent component

Specified by:

setParent in interface MessageArea<java.awt.Component>

Parameters:

parent - the parent component

rows - the number of rows

initializeHTMLContent

protected void initializeHTMLContent(int rows)

Initialize the HTML content. This method calls the initDocument() method an adds a listener on hyperlinks activation.

Parameters:

rows - the number of rows.

resize

protected void resize()

Resize the area. Ths method will be caleed when the parent content is shown or resized.

clear

public void clear()

Clear the content of the message area and resize it accordingly.

Specified by:

clear in interface MessageArea<java.awt.Component>

hasSelectedText

protected boolean hasSelectedText()

Return true if some text has been highlighted.

Returns:

true if some text has been highlighted

copyToClipboard

public void copyToClipboard()

Copy the hightlighted text to the system clipboard.

Specified by:

copyToClipboard in interface MessageArea<java.awt.Component>

print

protected void print()

Called when the "print" action is called.

save

protected void save()

Called when the "save" action is called.

print

public void print(java.io.File file)

Print the content of the area in a html file.

Specified by:

print in interface MessageArea<java.awt.Component>

Parameters:

file - the file

save

public void save(java.io.File file)

Save the content of the area in a file.

Specified by:

save in interface MessageArea<java.awt.Component>

Parameters:

file - the file

setStyleSheet

public void setStyleSheet(javax.swing.text.html.StyleSheet styleSheet)

Set the StyleSheet used on the document.

Specified by:

setStyleSheet in interface SwingMessageArea

Parameters:

styleSheet - the StyleSheet

initDocument

protected void initDocument()

Initialize the document. It will create an HTMLDocument which will be used in the area.

showPopupMenu

protected void showPopupMenu(int x,
                             int y)

Create the message area Popup menu.

Parameters:

x - the x position of the menu

y - the y position of the menu

append

public void append(java.lang.String txt)

Append a line of text in the message area.

Specified by:

append in interface MessageLogger

Parameters:

txt - the text

append

public void append(java.lang.String txt,
                   long time)

Append a line of text in the message area.

Specified by:

append in interface MessageLogger

Parameters:

txt - the text to show

time - the time

append

public void append(java.lang.String txt,
                   java.lang.String htmlColor)

Append a line of text in the message area.

Specified by:

append in interface MessageLogger

Parameters:

txt - the text to show

htmlColor - the html-define color to use for the text

append

public void append(java.lang.String txt,
                   java.lang.String htmlColor,
                   int fontSize,
                   int style)

Append a line of text in the message area.

Specified by:

append in interface MessageLogger

Parameters:

txt - the text to show

htmlColor - the html-defined color to use for the text

fontSize - the text font size

style - the text style

appendLink

public void appendLink(java.lang.String txt,
                       java.lang.String linkID)

Append a line of text with an hyperlink in the message area.

Specified by:

appendLink in interface MessageLogger

Specified by:

appendLink in interface MessageArea<java.awt.Component>

Parameters:

txt - the text to show

linkID - the link

appendLink

public void appendLink(java.lang.String txt,
                       java.lang.String linkID,
                       java.lang.Object o)

Append a line of text with an hyperlink in the message area.The link can be any text without space, and can be used as desired by the application.

Specified by:

appendLink in interface MessageArea<java.awt.Component>

Parameters:

txt - the text to show

linkID - the link

o - the object associated with the link

appendLink

public void appendLink(java.lang.String txt,
                       java.lang.String linkID,
                       java.lang.String htmlColor)

Append a line of text with an hyperlink in the message area.

Specified by:

appendLink in interface MessageLogger

Specified by:

appendLink in interface MessageArea<java.awt.Component>

Parameters:

txt - the text to show

linkID - the link

htmlColor - the html-define color to use for the text

appendLink

public void appendLink(java.lang.String txt,
                       java.lang.String linkID,
                       java.lang.String htmlColor,
                       java.lang.Object o)

Append a line of text with an hyperlink in the message area.

Specified by:

appendLink in interface MessageArea<java.awt.Component>

Parameters:

txt - the text to show

linkID - the link

htmlColor - the html-define color to use for the text

o - the object associated with the link

appendLink

public void appendLink(java.lang.String txt,
                       java.lang.String linkID,
                       java.lang.String htmlColor,
                       int fontSize,
                       int style)

Append a line of text with an hyperlink in the message area.

Specified by:

appendLink in interface MessageLogger

Parameters:

txt - the text to show

linkID - the link

htmlColor - the html-define color to use for the text

fontSize - the text font size

style - the text style

appendText

protected void appendText(java.lang.String text)

Append a line of text, considering the possible number of lines limitation.

Parameters:

text - the text