org.jboss.forge.ui.context

Interface UIContext

All Known Implementing Classes:

AbstractUIContext

public interface UIContext

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

Method Summary

Methods

Modifier and Type	Method and Description
Object	getAttribute(Object key) Get an Object from the UIContext attribute map.
<SELECTIONTYPE> UISelection<SELECTIONTYPE>	getInitialSelection() Get the user's initial selection.
<SELECTIONTYPE> SELECTIONTYPE	getSelection() Returns the selection passed on the setSelection(Object) method or null if no selection is needed for this interaction
Object	removeAttribute(Object key) Remove an Object from the UIContext attribute map.
void	setAttribute(Object key, Object value) Set an Object key in the UIContext attribute map to the given value.
<SELECTIONTYPE> void	setSelection(SELECTIONTYPE resource) Sets the current selection.

Method Detail

getAttribute

Object getAttribute(Object key)

Get an Object from the UIContext attribute map.

Returns:

null if no value was set.

removeAttribute

Object removeAttribute(Object key)

Remove an Object from the UIContext attribute map.

Returns:

null if no value was set.

setAttribute

void setAttribute(Object key,
                Object value)

Set an Object key in the UIContext attribute map to the given value.

getInitialSelection

<SELECTIONTYPE> UISelection<SELECTIONTYPE> getInitialSelection()

Get the user's initial selection.

setSelection

<SELECTIONTYPE> void setSelection(SELECTIONTYPE resource)

Sets the current selection.

Parameters:

resource - the resource to be selected

getSelection

<SELECTIONTYPE> SELECTIONTYPE getSelection()

Returns the selection passed on the setSelection(Object) method or null if no selection is needed for this interaction