org.jboss.forge.addon.ui.context

Interface UIContext

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

ShellContext

All Known Implementing Classes:

AbstractUIContext, UIContextImpl

public interface UIContext
extends AutoCloseable

An UIContext holds information about the environment the UICommand is being run, such as the initial selection and attributes that could be shared among several UIWizardStep of a single UIWizard instance.

Author:

George Gastaldi, Lincoln Baxter, III

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.forge.furnace.spi.ListenerRegistration<CommandExecutionListener>	addCommandExecutionListener(CommandExecutionListener listener) Add a CommandExecutionListener, returning the ListenerRegistration with which it may subsequently be removed.
Map<Object,Object>	getAttributeMap() Returns a modifiable map for this UIContext
<SELECTIONTYPE> UISelection<SELECTIONTYPE>	getInitialSelection() Get the user's UISelection at the time this command was initialized/selected.
Set<CommandExecutionListener>	getListeners() Returns the registered CommandExecutionListener objects for this UIContext.
UIProvider	getProvider() Returns the UIProvider that created this UIContext object.
<SELECTIONTYPE> UISelection<SELECTIONTYPE>	getSelection() Returns the selection set by setSelection(Object) or setSelection(UISelection) , or if no selection was set for this interaction, the value of getInitialSelection().
<SELECTIONTYPE> void	setSelection(SELECTIONTYPE resource) Sets a new selection.
<SELECTIONTYPE> void	setSelection(UISelection<SELECTIONTYPE> selection) Sets a new selection.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getAttributeMap

Map<Object,Object> getAttributeMap()

Returns a modifiable map for this UIContext

getInitialSelection

<SELECTIONTYPE> UISelection<SELECTIONTYPE> getInitialSelection()

Get the user's UISelection at the time this command was initialized/selected. (Never null.)

setSelection

<SELECTIONTYPE> void setSelection(SELECTIONTYPE resource)

Sets a new selection. (This will change the current working directory or UISelection - behavior varies somewhat depending on the UIProvider implementation.) The user's selection will be not be changed until after UICommand.execute(UIExecutionContext) has completed.

See Also:

UISelection

setSelection

<SELECTIONTYPE> void setSelection(UISelection<SELECTIONTYPE> selection)

Sets a new selection. (This will change the current working directory or UISelection - behavior varies somewhat depending on the UIProvider implementation.) The user's selection will be not be changed until after UICommand.execute(UIExecutionContext) has completed.

See Also:

UISelection

getSelection

<SELECTIONTYPE> UISelection<SELECTIONTYPE> getSelection()

Returns the selection set by setSelection(Object) or setSelection(UISelection) , or if no selection was set for this interaction, the value of getInitialSelection().

(***WARNING*** - This is NOT the same as getInitialSelection(). It will NOT return the user's initial selection if a new selection has previously been set via setSelection(Object) or setSelection(UISelection).)

See Also:

UISelection, getInitialSelection()

getProvider

UIProvider getProvider()

Returns the UIProvider that created this UIContext object. (Never null.)

addCommandExecutionListener

org.jboss.forge.furnace.spi.ListenerRegistration<CommandExecutionListener> addCommandExecutionListener(CommandExecutionListener listener)

Add a CommandExecutionListener, returning the ListenerRegistration with which it may subsequently be removed.

getListeners

Set<CommandExecutionListener> getListeners()

Returns the registered CommandExecutionListener objects for this UIContext. (Never null.)