org.jboss.forge.addon.ui.context

Class AbstractUIContext

java.lang.Object

org.jboss.forge.addon.ui.context.AbstractUIContext

All Implemented Interfaces:

AutoCloseable, UIContext

Direct Known Subclasses:

UIContextImpl

public abstract class AbstractUIContext
extends Object
implements UIContext

This class provides a skeletal implementation of the UIContext interface, to minimize the effort required to implement this interface.

Author:

Lincoln Baxter, III, George Gastaldi

Constructor Summary

Constructors

Constructor and Description
AbstractUIContext()

Method Summary

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.
void	clearListeners()
void	close()
Map<Object,Object>	getAttributeMap() Returns a modifiable map for this UIContext
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 UIContext.setSelection(Object) or UIContext.setSelection(UISelection) , or if no selection was set for this interaction, the value of UIContext.getInitialSelection().
<SELECTIONTYPE> void	setSelection(SELECTIONTYPE selection) Sets a new selection.
<SELECTIONTYPE> void	setSelection(UISelection<SELECTIONTYPE> selection) Sets a new selection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.forge.addon.ui.context.UIContext

getInitialSelection

Constructor Detail

AbstractUIContext

public AbstractUIContext()

Method Detail

getSelection

public <SELECTIONTYPE> UISelection<SELECTIONTYPE> getSelection()

Description copied from interface: UIContext

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

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

Specified by:

getSelection in interface UIContext

See Also:

UISelection, UIContext.getInitialSelection()

setSelection

public <SELECTIONTYPE> void setSelection(SELECTIONTYPE selection)

Description copied from interface: UIContext

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.

Specified by:

setSelection in interface UIContext

See Also:

UISelection

setSelection

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

Description copied from interface: UIContext

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.

Specified by:

setSelection in interface UIContext

See Also:

UISelection

getAttributeMap

public Map<Object,Object> getAttributeMap()

Description copied from interface: UIContext

Returns a modifiable map for this UIContext

Specified by:

getAttributeMap in interface UIContext

getProvider

public UIProvider getProvider()

Description copied from interface: UIContext

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

Specified by:

getProvider in interface UIContext

close

public void close()

Specified by:

close in interface AutoCloseable

addCommandExecutionListener

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

Description copied from interface: UIContext

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

Specified by:

addCommandExecutionListener in interface UIContext

getListeners

public Set<CommandExecutionListener> getListeners()

Description copied from interface: UIContext

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

Specified by:

getListeners in interface UIContext

clearListeners

public void clearListeners()