A C D E F G H I M N O R S T U V W

A

AbstractUIContext - Class in org.jboss.forge.ui.context

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

AbstractUIContext() - Constructor for class org.jboss.forge.ui.context.AbstractUIContext

add(InputComponent<?, ?>) - Method in interface org.jboss.forge.ui.context.UIBuilder

addValidationError(InputComponent<?, ?>, String) - Method in interface org.jboss.forge.ui.context.UIValidationContext

C

Categories - Class in org.jboss.forge.ui.util

Utility for creating hierarchical UICategory instances.

Categories() - Constructor for class org.jboss.forge.ui.util.Categories

category(UICategory) - Method in class org.jboss.forge.ui.util.Metadata

create(String...) - Static method in class org.jboss.forge.ui.util.Categories

Using the given category names, produce a hierarchical UICategory instance.

D

description(String) - Method in class org.jboss.forge.ui.util.Metadata

docLocation(URL) - Method in class org.jboss.forge.ui.util.Metadata

E

execute(UIContext) - Method in interface org.jboss.forge.ui.UICommand

F

fail(String) - Static method in class org.jboss.forge.ui.result.Results

fail(String, Throwable) - Static method in class org.jboss.forge.ui.result.Results

Failed - Interface in org.jboss.forge.ui.result

Represents a failed Result

forCommand(Class<? extends UICommand>) - Static method in class org.jboss.forge.ui.util.Metadata

G

get() - Method in interface org.jboss.forge.ui.context.UISelection

Provides the first selected element as a SELECTIONTYPE.

getAttribute(Object) - Method in class org.jboss.forge.ui.context.AbstractUIContext

getAttribute(Object) - Method in interface org.jboss.forge.ui.context.UIContext

Get an Object from the UIContext attribute map.

getCategory() - Method in interface org.jboss.forge.ui.metadata.UICommandMetadata

getCategory() - Method in class org.jboss.forge.ui.util.Metadata

getCompleter() - Method in interface org.jboss.forge.ui.input.HasCompleter

getCompletionProposals(InputComponent<?, VALUETYPE>, String) - Method in interface org.jboss.forge.ui.input.UICompleter

Get completion proposals for the provided UIInput and un-converted partial String value.

getDescription() - Method in interface org.jboss.forge.ui.metadata.UICommandMetadata

getDescription() - Method in class org.jboss.forge.ui.util.Metadata

getDocLocation() - Method in interface org.jboss.forge.ui.metadata.UICommandMetadata

Returns the location of the documentation of this command

getDocLocation() - Method in class org.jboss.forge.ui.util.Metadata

getException() - Method in interface org.jboss.forge.ui.result.Failed

getException() - Method in class org.jboss.forge.ui.result.Results

getInitialSelection() - Method in interface org.jboss.forge.ui.context.UIContext

Get the user's initial selection.

getInputType() - Method in interface org.jboss.forge.ui.facets.HintsFacet

getInputType(InputComponent<?, ?>) - Static method in class org.jboss.forge.ui.util.InputComponents

getItemLabelConverter() - Method in interface org.jboss.forge.ui.input.SelectComponent

getItemLabelConverter(ConverterFactory, SelectComponent<?, ?>) - Static method in class org.jboss.forge.ui.util.InputComponents

Returns the item label converter, that is

getLabel() - Method in interface org.jboss.forge.ui.input.InputComponent

getMessage() - Method in interface org.jboss.forge.ui.result.Result

getMessage() - Method in class org.jboss.forge.ui.result.Results

getMetadata() - Method in interface org.jboss.forge.ui.UICommand

getName() - Method in interface org.jboss.forge.ui.input.InputComponent

getName() - Method in interface org.jboss.forge.ui.metadata.UICategory

getName() - Method in interface org.jboss.forge.ui.metadata.UICommandMetadata

getName() - Method in class org.jboss.forge.ui.util.Metadata

getNext() - Method in interface org.jboss.forge.ui.result.NavigationResult

getRequiredMessage() - Method in interface org.jboss.forge.ui.input.InputComponent

getSelection() - Method in class org.jboss.forge.ui.context.AbstractUIContext

getSelection() - Method in interface org.jboss.forge.ui.context.UIContext

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

getSubCategory() - Method in interface org.jboss.forge.ui.metadata.UICategory

getUIContext() - Method in interface org.jboss.forge.ui.context.UIContextProvider

Returns the UIContext that is shared through all the UICommand instances in an interaction with the user.

getValue() - Method in interface org.jboss.forge.ui.input.ManyValued

getValue() - Method in interface org.jboss.forge.ui.input.SingleValued

getValueChoices() - Method in interface org.jboss.forge.ui.input.SelectComponent

getValueConverter() - Method in interface org.jboss.forge.ui.input.InputComponent

getValueFor(InputComponent<?, ?>) - Static method in class org.jboss.forge.ui.util.InputComponents

getValueType() - Method in interface org.jboss.forge.ui.input.InputComponent

H

HasCompleter<IMPL,VALUETYPE> - Interface in org.jboss.forge.ui.input

Provides a UICompleter object

hasValue(InputComponent<?, ?>) - Static method in class org.jboss.forge.ui.util.InputComponents

Returns if there is a value set for this InputComponent

HintsFacet - Interface in org.jboss.forge.ui.facets

Hints facet

I

initializeUI(UIBuilder) - Method in interface org.jboss.forge.ui.UICommand

InputComponent<IMPLTYPE,VALUETYPE> - Interface in org.jboss.forge.ui.input

This is the parent interface of all inputs.

InputComponents - Class in org.jboss.forge.ui.util

Utilities for InputComponent objects

InputComponents() - Constructor for class org.jboss.forge.ui.util.InputComponents

isEnabled() - Method in interface org.jboss.forge.ui.input.InputComponent

isEnabled(UIContext) - Method in interface org.jboss.forge.ui.UICommand

isRequired() - Method in interface org.jboss.forge.ui.input.InputComponent

M

ManyValued<IMPL,VALUETYPE> - Interface in org.jboss.forge.ui.input

UI components implementing this interface hold multiple values

Metadata - Class in org.jboss.forge.ui.util

Metadata(Class<? extends UICommand>) - Constructor for class org.jboss.forge.ui.util.Metadata

N

name(String) - Method in class org.jboss.forge.ui.util.Metadata

navigateTo(Class<? extends UICommand>) - Static method in class org.jboss.forge.ui.result.Results

navigateTo(Class<? extends UICommand>, String) - Static method in class org.jboss.forge.ui.result.Results

NavigationResult - Interface in org.jboss.forge.ui.result

The result of a navigation

next(UIContext) - Method in interface org.jboss.forge.ui.wizard.UIWizard

Returns the next UIWizardStep, or null if this is the last UICommand in the flow.

O

org.jboss.forge.ui - package org.jboss.forge.ui

org.jboss.forge.ui.context - package org.jboss.forge.ui.context

org.jboss.forge.ui.facets - package org.jboss.forge.ui.facets

org.jboss.forge.ui.input - package org.jboss.forge.ui.input

org.jboss.forge.ui.metadata - package org.jboss.forge.ui.metadata

org.jboss.forge.ui.result - package org.jboss.forge.ui.result

org.jboss.forge.ui.util - package org.jboss.forge.ui.util

org.jboss.forge.ui.wizard - package org.jboss.forge.ui.wizard

R

removeAttribute(Object) - Method in class org.jboss.forge.ui.context.AbstractUIContext

removeAttribute(Object) - Method in interface org.jboss.forge.ui.context.UIContext

Remove an Object from the UIContext attribute map.

Result - Interface in org.jboss.forge.ui.result

The result of an execution

Results - Class in org.jboss.forge.ui.result

Results(String, Throwable) - Constructor for class org.jboss.forge.ui.result.Results

ResultsFail - Class in org.jboss.forge.ui.result

ResultsFail(String, Throwable) - Constructor for class org.jboss.forge.ui.result.ResultsFail

ResultSuccess - Class in org.jboss.forge.ui.result

S

SelectComponent<IMPLTYPE,VALUETYPE> - Interface in org.jboss.forge.ui.input

Parent interface for UISelect components

setAttribute(Object, Object) - Method in class org.jboss.forge.ui.context.AbstractUIContext

setAttribute(Object, Object) - Method in interface org.jboss.forge.ui.context.UIContext

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

setCompleter(UICompleter<VALUETYPE>) - Method in interface org.jboss.forge.ui.input.HasCompleter

setDefaultValue(Iterable<VALUETYPE>) - Method in interface org.jboss.forge.ui.input.ManyValued

setDefaultValue(Callable<Iterable<VALUETYPE>>) - Method in interface org.jboss.forge.ui.input.ManyValued

setDefaultValue(VALUETYPE) - Method in interface org.jboss.forge.ui.input.SingleValued

setDefaultValue(Callable<VALUETYPE>) - Method in interface org.jboss.forge.ui.input.SingleValued

setEnabled(boolean) - Method in interface org.jboss.forge.ui.input.InputComponent

setEnabled(Callable<Boolean>) - Method in interface org.jboss.forge.ui.input.InputComponent

setInputType(InputType) - Method in interface org.jboss.forge.ui.facets.HintsFacet

setItemLabelConverter(Converter<VALUETYPE, String>) - Method in interface org.jboss.forge.ui.input.SelectComponent

setLabel(String) - Method in interface org.jboss.forge.ui.input.InputComponent

setRequired(boolean) - Method in interface org.jboss.forge.ui.input.InputComponent

setRequired(Callable<Boolean>) - Method in interface org.jboss.forge.ui.input.InputComponent

setRequiredMessage(String) - Method in interface org.jboss.forge.ui.input.InputComponent

setSelection(SELECTIONTYPE) - Method in class org.jboss.forge.ui.context.AbstractUIContext

setSelection(SELECTIONTYPE) - Method in interface org.jboss.forge.ui.context.UIContext

Sets the current selection.

setValue(Iterable<VALUETYPE>) - Method in interface org.jboss.forge.ui.input.ManyValued

setValue(VALUETYPE) - Method in interface org.jboss.forge.ui.input.SingleValued

setValueChoices(Iterable<VALUETYPE>) - Method in interface org.jboss.forge.ui.input.SelectComponent

setValueConverter(Converter<String, VALUETYPE>) - Method in interface org.jboss.forge.ui.input.InputComponent

setValueFor(ConverterFactory, InputComponent<?, Object>, Object) - Static method in class org.jboss.forge.ui.util.InputComponents

Sets the value in the provided InputComponent, making any necessary conversions

SingleValued<IMPL,VALUETYPE> - Interface in org.jboss.forge.ui.input

UI components implementing this interface hold a single value

size() - Method in interface org.jboss.forge.ui.context.UISelection

Counts the elements in this selection.

success() - Static method in class org.jboss.forge.ui.result.Results

success(String) - Static method in class org.jboss.forge.ui.result.Results

T

toString() - Method in class org.jboss.forge.ui.util.Metadata

U

UIBuilder - Interface in org.jboss.forge.ui.context

Allows UICommand objects to specify the order of the displayed fields Each wizard page receives an unique instance of UIBuilder

UICategory - Interface in org.jboss.forge.ui.metadata

UICommand - Interface in org.jboss.forge.ui

UICommandMetadata - Interface in org.jboss.forge.ui.metadata

UICompleter<VALUETYPE> - Interface in org.jboss.forge.ui.input

UIContext - Interface in org.jboss.forge.ui.context

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

UIContextProvider - Interface in org.jboss.forge.ui.context

Provides a UIContext object

UIInput<VALUETYPE> - Interface in org.jboss.forge.ui.input

A UIInput prompts for a single value.

UIInputMany<VALUETYPE> - Interface in org.jboss.forge.ui.input

A UIInputMany prompts for multiple values.

UISelection<SELECTIONTYPE> - Interface in org.jboss.forge.ui.context

Represents the objects with on which the UIContext is currently focused.

UISelectMany<VALUETYPE> - Interface in org.jboss.forge.ui.input

A UISelectMany should be used when the number of items to be chosen are known before rendering the component.

UISelectOne<VALUETYPE> - Interface in org.jboss.forge.ui.input

A UISelectMany should be used when the number of items to be chosen are known before rendering the component.

UIValidationContext - Interface in org.jboss.forge.ui.context

UIWizard - Interface in org.jboss.forge.ui.wizard

An UICommand that supports multiple steps.

UIWizardStep - Interface in org.jboss.forge.ui.wizard

Marker interface for wizard steps.

V

validate(UIValidationContext) - Method in interface org.jboss.forge.ui.UICommand

validateRequired(InputComponent<?, ?>) - Static method in class org.jboss.forge.ui.util.InputComponents

Validate if the input has a value.

W

WithAttributes - Annotation Type in org.jboss.forge.ui.metadata

Allows configuration of InputComponent injected fields

A C D E F G H I M N O R S T U V W