com.gluonhq.charm.glisten.control

Class Message

java.lang.Object

com.gluonhq.charm.glisten.control.Message

Direct Known Subclasses:

Snackbar, Toast

@IDProperty(value="id")
public abstract class Message
extends java.lang.Object

Message provide lightweight feedback about an operation. They are displayed at the bottom of the screen and disappear automatically. Developers are advised to use a duration of either LENGTH_SHORT or LENGTH_LONG which corresponds to 2 and 3.5 seconds respectively.

There are two types of Message:

• Snackbar - Messages related to an action performed.
• Toast - Messages related but not restricted to system updates.

Since:

5.0.0

See Also:

Snackbar, Toast

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<javafx.util.Duration>	duration The time the Message is shown.
javafx.beans.property.StringProperty	id The id of this Message.
javafx.beans.property.StringProperty	message The message to display.

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.util.Duration	LENGTH_LONG A long amount of time to display the message - 3500 ms.
static javafx.util.Duration	LENGTH_SHORT A short amount of time to display the message - 2000 ms.

Constructor Summary

Constructors

Constructor and Description
Message()

Method Summary

Modifier and Type	Method and Description
abstract void	cancel() If the Message is currently showing, calling this method will hide it immediately and show the next Message in queue.
javafx.beans.property.ObjectProperty<javafx.util.Duration>	durationProperty() The time the Message is shown.
javafx.util.Duration	getDuration() Gets the value of the property duration.
java.lang.String	getId() Gets the value of the property id.
java.lang.String	getMessage() Gets the value of the property message.
javafx.beans.property.StringProperty	idProperty() The id of this Message.
javafx.beans.property.StringProperty	messageProperty() The message to display.
void	setDuration(javafx.util.Duration duration) Sets the value of the property duration.
void	setId(java.lang.String id) Sets the value of the property id.
void	setMessage(java.lang.String text) Sets the value of the property message.
abstract void	show() Shows the Message immediately, if no other message is showing.

Methods inherited from class java.lang.Object

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

Property Detail

message

public final javafx.beans.property.StringProperty messageProperty

The message to display.

See Also:

getMessage(), setMessage(String)

duration

public final javafx.beans.property.ObjectProperty<javafx.util.Duration> durationProperty

The time the Message is shown.

See Also:

getDuration(), setDuration(Duration)

id

public final javafx.beans.property.StringProperty idProperty

The id of this Message. This simple string identifier is useful for finding a specific Message within the scene graph. While the id of a notification should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a notification is given the id of "myId", then the lookup method can be used to find this notification as follows: scene.lookup("#myId");.

Default value:

null

See Also:

getId(), setId(String)

Field Detail

LENGTH_SHORT

public static final javafx.util.Duration LENGTH_SHORT

A short amount of time to display the message - 2000 ms.

LENGTH_LONG

public static final javafx.util.Duration LENGTH_LONG

A long amount of time to display the message - 3500 ms.

Constructor Detail

Message

public Message()

Method Detail

setMessage

public final void setMessage(java.lang.String text)

Sets the value of the property message.

Property description:

The message to display.

getMessage

public final java.lang.String getMessage()

Gets the value of the property message.

Property description:

The message to display.

messageProperty

public final javafx.beans.property.StringProperty messageProperty()

The message to display.

See Also:

getMessage(), setMessage(String)

setDuration

public final void setDuration(javafx.util.Duration duration)

Sets the value of the property duration.

Property description:

The time the Message is shown.

getDuration

public final javafx.util.Duration getDuration()

Gets the value of the property duration.

Property description:

The time the Message is shown.

durationProperty

public final javafx.beans.property.ObjectProperty<javafx.util.Duration> durationProperty()

The time the Message is shown.

See Also:

getDuration(), setDuration(Duration)

idProperty

public final javafx.beans.property.StringProperty idProperty()

The id of this Message. This simple string identifier is useful for finding a specific Message within the scene graph. While the id of a notification should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a notification is given the id of "myId", then the lookup method can be used to find this notification as follows: scene.lookup("#myId");.

Default value:

null

See Also:

getId(), setId(String)

setId

public final void setId(java.lang.String id)

Sets the value of the property id.

Property description:

The id of this Message. This simple string identifier is useful for finding a specific Message within the scene graph. While the id of a notification should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a notification is given the id of "myId", then the lookup method can be used to find this notification as follows: scene.lookup("#myId");.

Default value:

null

getId

public final java.lang.String getId()

Gets the value of the property id.

Property description:

The id of this Message. This simple string identifier is useful for finding a specific Message within the scene graph. While the id of a notification should be unique within the scene graph, this uniqueness is not enforced. This is analogous to the "id" attribute on an HTML element (CSS ID Specification).

For example, if a notification is given the id of "myId", then the lookup method can be used to find this notification as follows: scene.lookup("#myId");.

Default value:

null

show

public abstract void show()

Shows the Message immediately, if no other message is showing. If a message is already showing, it gets added to the waiting queue and will show when its turn arrives.

cancel

public abstract void cancel()

If the Message is currently showing, calling this method will hide it immediately and show the next Message in queue. If the Message is waiting in the queue, calling this method removes the Message from the queue and the Message is never shown.