org.mdi.gui

Interface MessageArea<C>

Type Parameters:

C - the parent component for the area

All Superinterfaces:

MessageLogger

All Known Subinterfaces:

SwingMessageArea

All Known Implementing Classes:

DefaultMessageArea

public interface MessageArea<C>
extends MessageLogger

Presents a scrollable text area for user messages.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_LINES The default maximum lines number.

Fields inherited from interface org.mdi.bootstrap.MessageLogger

BOLD, CROSSED, DEFAULT_FONT_SIZE, DEFAULT_STYLE, ITALIC, UNDERLINE

Method Summary

Modifier and Type	Method and Description
void	addHandler(MessageAreaHandler handler) Add a handler which will be fired after Hyperlink selections in the 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, java.lang.Object o) Append a line of text with an hyperlink in the message area.
void	clear() Clear the content of the message area and resize it accordingly.
default void	copyToClipboard() Copy the hightlighted text to the system clipboard.
default MessageAreaHandler	getHandler() Return the message area handler.
int	getMaximumLines() Return the maximum lines to be displayed, or -1 if there is no limitation.
MessageAreaHandler	getMessageAreaHandler() Return the 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.
default boolean	isEditable() Return true if the message area is editable.
default boolean	isHandlingRightClick() Return true if the message area is handing right clicks.
default boolean	isManagingClipBoard() True if the area is managing the clipboard.
default void	manageClipBoard(boolean manageClipboard) Set if the area is managing the clipboard.
default void	print(java.io.File file) Print the content of the area in a html file.
default void	save(java.io.File file) Save the content of the area in a text file.
void	setHandler(MessageAreaHandler handler) Deprecated.
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(C parent, int rows) Set the parent component

Methods inherited from interface org.mdi.bootstrap.MessageLogger

append, append, append, append, appendError, appendLink

Field Detail

DEFAULT_MAXIMUM_LINES

static final int DEFAULT_MAXIMUM_LINES

The default maximum lines number.

See Also:

Constant Field Values

Method Detail

addHandler

void addHandler(MessageAreaHandler handler)

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

Parameters:

handler - the handler

setHandler

@Deprecated
void setHandler(MessageAreaHandler handler)

Deprecated.

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

Parameters:

handler - the handler

getMessageAreaHandler

MessageAreaHandler getMessageAreaHandler()

Return the message area handler.

Returns:

the handler

getMessageAreaHandlers

java.util.List<MessageAreaHandler> getMessageAreaHandlers()

Return the message area handlers.

Returns:

the handlers

getHandler

default MessageAreaHandler getHandler()

Return the message area handler. Identical to getMessageAreaHandler().

Returns:

the handler

setMaximumLines

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

Parameters:

maximumLines - the maximum of lines

setMaximumLinesBehavior

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

Parameters:

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

getMaximumLines

int getMaximumLines()

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

Returns:

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

hasMaximumLines

boolean hasMaximumLines()

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

Returns:

true if the number of lines to be displayed is limited

setParent

void setParent(C parent,
               int rows)

Set the parent component

Parameters:

parent - the parent component

rows - the number of rows

manageClipBoard

default void manageClipBoard(boolean manageClipboard)

Set if the area is managing the clipboard. Do nothing by default.

Parameters:

manageClipboard - true if the area is managing the clipboard

isManagingClipBoard

default boolean isManagingClipBoard()

True if the area is managing the clipboard. Return false by default.

Returns:

true if the area is managing the clipboard

clear

void clear()

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

copyToClipboard

default void copyToClipboard()

Copy the hightlighted text to the system clipboard.

print

default void print(java.io.File file)

Print the content of the area in a html file. Do nothing by default.

Parameters:

file - the file

save

default void save(java.io.File file)

Save the content of the area in a text file. Do nothing by default.

Parameters:

file - the file

appendLink

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

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 MessageLogger

Parameters:

txt - the text to show

linkID - the link

appendLink

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.

Parameters:

txt - the text to show

linkID - the link

o - the object associated with the link

appendLink

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

Parameters:

txt - the text to show

linkID - the link

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

appendLink

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.

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

isHandlingRightClick

default boolean isHandlingRightClick()

Return true if the message area is handing right clicks. Return false by dfault.

Returns:

true if the message area is handing right clicks

isEditable

default boolean isEditable()

Return true if the message area is editable.

Returns:

false by default.