Package qupath.lib.gui.actions

Class InfoMessage

java.lang.Object

qupath.lib.gui.actions.InfoMessage

public class InfoMessage
extends Object

An informative message that should be shown to the user.

Property Summary

Properties

Type	Property	Description
ReadOnlyObjectProperty<Number>	count	Read only property containing any count associated with the text (may be null).
ReadOnlyStringProperty	text	Read only property containing the message text.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	InfoMessage.MessageType	The type of message, which can be used for styling.

Method Summary

Modifier and Type	Method	Description
ReadOnlyObjectProperty<Number>	countProperty()	Read only property containing any count associated with the text (may be null).
static InfoMessage	error(String text)	Create an error message with static text.
static InfoMessage	error(String text, int count)	Create an error message with static text and a count.
static InfoMessage	error(ObservableNumberValue count)	Create a error message to show a count of errors.
static InfoMessage	error(ObservableValue<String> text)	Create an error message.
static InfoMessage	error(ObservableValue<String> text, ObservableNumberValue count)	Create an error message with a count.
int	getCount()	Counts associated with the message, or -1 if the count is null.
InfoMessage.MessageType	getMessageType()	Type of the message.
String	getText()	Text of the message.
static InfoMessage	info(String text)	Create an information message with static text.
static InfoMessage	info(String text, int count)	Create an information message with static text and a count.
static InfoMessage	info(ObservableNumberValue count)	Create a information message to show a count of messages.
static InfoMessage	info(ObservableValue<String> text)	Create an information message.
static InfoMessage	info(ObservableValue<String> text, ObservableNumberValue count)	Create an information message with a count.
ReadOnlyStringProperty	textProperty()	Read only property containing the message text.
static InfoMessage	warning(String text)	Create a warning message with static text.
static InfoMessage	warning(String text, int count)	Create a warning message with static text and a count.
static InfoMessage	warning(ObservableNumberValue count)	Create a warning message to show a count of warnings.
static InfoMessage	warning(ObservableValue<String> text)	Create a warning message.
static InfoMessage	warning(ObservableValue<String> text, ObservableNumberValue count)	Create a warning message with a count.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

text

public ReadOnlyStringProperty textProperty

Read only property containing the message text.

See Also:

• getText()

count

public ReadOnlyObjectProperty<Number> countProperty

Read only property containing any count associated with the text (may be null).

See Also:

• getCount()

Method Details

info

public static InfoMessage info(ObservableValue<String> text)

Create an information message.

Parameters:

text -

Returns:

info

public static InfoMessage info(String text)

Create an information message with static text.

Parameters:

text -

Returns:

info

public static InfoMessage info(ObservableValue<String> text,
 ObservableNumberValue count)

Create an information message with a count.

Parameters:

text -

count -

Returns:

info

public static InfoMessage info(String text,
 int count)

Create an information message with static text and a count.

Parameters:

text -

count -

Returns:

info

public static InfoMessage info(ObservableNumberValue count)

Create a information message to show a count of messages.

Parameters:

count -

Returns:

warning

public static InfoMessage warning(ObservableValue<String> text)

Create a warning message.

Parameters:

text -

Returns:

warning

public static InfoMessage warning(String text)

Create a warning message with static text.

Parameters:

text -

Returns:

warning

public static InfoMessage warning(ObservableValue<String> text,
 ObservableNumberValue count)

Create a warning message with a count.

Parameters:

text -

count -

Returns:

warning

public static InfoMessage warning(ObservableNumberValue count)

Create a warning message to show a count of warnings.

Parameters:

count -

Returns:

warning

public static InfoMessage warning(String text,
 int count)

Create a warning message with static text and a count.

Parameters:

text -

count -

Returns:

error

public static InfoMessage error(ObservableValue<String> text)

Create an error message.

Parameters:

text -

Returns:

error

public static InfoMessage error(String text)

Create an error message with static text.

Parameters:

text -

Returns:

error

public static InfoMessage error(ObservableValue<String> text,
 ObservableNumberValue count)

Create an error message with a count.

Parameters:

text -

count -

Returns:

error

public static InfoMessage error(String text,
 int count)

Create an error message with static text and a count.

Parameters:

text -

count -

Returns:

error

public static InfoMessage error(ObservableNumberValue count)

Create a error message to show a count of errors.

Parameters:

count -

Returns:

textProperty

public ReadOnlyStringProperty textProperty()

Read only property containing the message text.

See Also:

• getText()

getText

public String getText()

Text of the message.

Returns:

countProperty

public ReadOnlyObjectProperty<Number> countProperty()

Read only property containing any count associated with the text (may be null).

See Also:

• getCount()

getCount

public int getCount()

Counts associated with the message, or -1 if the count is null.

Returns:

getMessageType

public InfoMessage.MessageType getMessageType()

Type of the message.

Returns: