Package org.apache.pivot.wtk

Interface PromptListener

All Known Implementing Classes:

PromptListener.Adapter, PromptListener.Listeners, TerraPromptSkin

public interface PromptListener

Prompt listener interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PromptListener.Adapter	Deprecated. Since 2.1 and Java 8 the interface itself has default implementations.
static class	PromptListener.Listeners	Prompt listeners.

Method Summary

Modifier and Type	Method	Description
default void	bodyChanged(Prompt prompt, Component previousBody)	Called when a prompt's body has changed.
default void	messageChanged(Prompt prompt, java.lang.String previousMessage)	Called when a prompt's message has changed.
default void	messageTypeChanged(Prompt prompt, MessageType previousMessageType)	Called when a prompt's message type has changed.
default void	optionInserted(Prompt prompt, int index)	Called when an option has been inserted into a prompt's option sequence.
default void	optionsRemoved(Prompt prompt, int index, Sequence<?> removed)	Called when options have been removed from a prompt's option sequence.
default void	selectedOptionChanged(Prompt prompt, int previousSelectedOption)	Called when a prompt's selected option has changed.

Method Detail

messageTypeChanged

default void messageTypeChanged(Prompt prompt,
                                MessageType previousMessageType)

Called when a prompt's message type has changed.

Parameters:

prompt - The prompt object that has been changed.

previousMessageType - The message type before the change.

messageChanged

default void messageChanged(Prompt prompt,
                            java.lang.String previousMessage)

Called when a prompt's message has changed.

Parameters:

prompt - The prompt whose message has changed.

previousMessage - What the message used to be.

bodyChanged

default void bodyChanged(Prompt prompt,
                         Component previousBody)

Called when a prompt's body has changed.

Parameters:

prompt - The prompt that has changed.

previousBody - What the body of this prompt used to be.

optionInserted

default void optionInserted(Prompt prompt,
                            int index)

Called when an option has been inserted into a prompt's option sequence.

Parameters:

prompt - The prompt whose options have changed.

index - The location where the new option was inserted.

optionsRemoved

default void optionsRemoved(Prompt prompt,
                            int index,
                            Sequence<?> removed)

Called when options have been removed from a prompt's option sequence.

Parameters:

prompt - The prompt whose options have changed.

index - The starting location of the removed options.

removed - The actual sequence of options removed.

selectedOptionChanged

default void selectedOptionChanged(Prompt prompt,
                                   int previousSelectedOption)

Called when a prompt's selected option has changed.

Parameters:

prompt - The prompt that changed.

previousSelectedOption - The option that used to be the selected one.