Contextual (SciJava Javadocs 0-SNAPSHOT API)

All Known Subinterfaces:

App, AppEventService, AppService, BatchInputProvider, BatchService, ButtonWidget, CacheService, ChoiceWidget, CodeRunner, ColorWidget, CommandService, ConsoleArgument, ConsoleService, Converter<I,O>, ConvertService, DataHandle<L>, DataHandleService, DateWidget, Display<T>, DisplayService, DisplayViewer<T>, DownloadService, DragAndDropHandler<D>, DragAndDropService, EventHistory, EventService, FileListWidget, FileWidget, Gateway, GrabService, HandlerPlugin<D>, HandlerService<DT,PT>, IconService, InputService, InputWidget<T,W>, IOPlugin<D>, IOService, Java3DService, JavadocService, LanguageSupportService, LocationResolver, LocationService, LogService, MainService, MATLABCommands, MATLABService, MenuService, MessageWidget, ModuleService, NIOService, NumberWidget, ObjectService, ObjectWidget, OptionsService, ParseService, PlatformService, PluginService, PostprocessorPlugin, PrefService, PreprocessorPlugin, PTService<PT>, RecentFileService, ResettableStreamHandle<L>, RichPlugin, RunService, SciJavaService, ScriptHeader, ScriptHeaderService, ScriptInfoWidget, ScriptLanguage, ScriptProcessorService, ScriptService, SearchService, SeekableStreamHandle<L>, Service, SingletonService<PT>, StartupService, StatusService, StreamHandle<L>, TableDisplay, TableDisplayViewer, TableIOPlugin, TableIOService, TaskService, TextDisplay, TextDisplayViewer, TextFormat, TextIOService, TextService, TextWidget, ThreadService, ToggleWidget, Tool, ToolService, TypedIOService<D>, TypedPlugin<D>, TypedService<DT,PT>, UIService, UserInterface, WelcomeService, WidgetModel, WidgetService, WrapperPlugin<D>, WrapperService<DT,PT>

All Known Implementing Classes:

AbstractApp, AbstractCodeRunner, AbstractConsoleArgument, AbstractContextual, AbstractConverter, AbstractConvertService, AbstractDataHandle, AbstractDelegateConverter, AbstractDisplay, AbstractDisplayViewer, AbstractDragAndDropData, AbstractDragAndDropHandler, AbstractGateway, AbstractHandlerPlugin, AbstractHandlerService, AbstractHigherOrderHandle, AbstractInputHarvester, AbstractInputHarvesterPlugin, AbstractInputWidget, AbstractIOPlugin, AbstractLocationResolver, AbstractLogService, AbstractPostprocessorPlugin, AbstractPrefService, AbstractPreprocessorPlugin, AbstractPTService, AbstractRichPlugin, AbstractScriptHeader, AbstractScriptLanguage, AbstractSeekableStreamHandle, AbstractService, AbstractSingleInputPreprocessor, AbstractSingletonService, AbstractStreamHandle, AbstractSwingUI, AbstractTableDisplayViewer, AbstractTextDisplayViewer, AbstractTextFormat, AbstractTool, AbstractTypedIOService, AbstractTypedPlugin, AbstractTypedService, AbstractUIInputWidget, AbstractUserInterface, AbstractWrapperPlugin, AbstractWrapperService, ActiveDisplayPreprocessor, AdaptedScriptLanguage, AppAboutEvent, AppFocusEvent, ApplicationEvent, AppMenusCreatedEvent, AppOpenFilesEvent, AppPreferencesEvent, AppPrintEvent, AppQuitEvent, AppReOpenEvent, AppScreenSleepEvent, AppSleepEvent, AppSystemSleepEvent, AppUserSessionEvent, AppVisibleEvent, ArrayConverters.BoolArrayUnwrapper, ArrayConverters.BoolArrayWrapper, ArrayConverters.ByteArrayUnwrapper, ArrayConverters.ByteArrayWrapper, ArrayConverters.CharArrayUnwrapper, ArrayConverters.CharArrayWrapper, ArrayConverters.DoubleArrayUnwrapper, ArrayConverters.DoubleArrayWrapper, ArrayConverters.FloatArrayUnwrapper, ArrayConverters.FloatArrayWrapper, ArrayConverters.IntArrayUnwrapper, ArrayConverters.IntArrayWrapper, ArrayConverters.LongArrayUnwrapper, ArrayConverters.LongArrayWrapper, ArrayConverters.ShortArrayUnwrapper, ArrayConverters.ShortArrayWrapper, AWTButtonWidget, AWTChoiceWidget, AWTDragAndDropData, AWTFileWidget, AWTInputHarvester, AWTInputWidget, AWTMessageWidget, AWTNumberWidget, AWTObjectWidget, AWTTextWidget, AWTToggleWidget, AWTUI, BeanshellScriptLanguage, BytesHandle, CastingConverter, CheckInputsPreprocessor, ChooseFontSize, ChooseTabSize, ClojureScriptLanguage, Close, CloseAll, CommandCodeRunner, CommandFinder, CommandModule, ContextCommand, ContextDisposingEvent, DataOpenedEvent, DataSavedEvent, DebugPostprocessor, DebugPreprocessor, DefaultAppEventService, DefaultAppService, DefaultCacheService, DefaultCommandService, DefaultConsoleService, DefaultConverter, DefaultConvertService, DefaultDataHandleService, DefaultDisplay, DefaultDisplayService, DefaultDownloadService, DefaultDragAndDropData, DefaultDragAndDropService, DefaultEventHistory, DefaultEventService, DefaultGrabService, DefaultInputService, DefaultIOService, DefaultJava3DService, DefaultJavadocService, DefaultLanguageSupportService, DefaultLocationService, DefaultMainService, DefaultMATLABService, DefaultMenuService, DefaultModuleService, DefaultNIOService, DefaultObjectService, DefaultOptionsService, DefaultParseService, DefaultPlatformService, DefaultPluginService, DefaultPrefService, DefaultRecentFileService, DefaultRunService, DefaultScriptHeaderService, DefaultScriptProcessorService, DefaultScriptService, DefaultSearchService, DefaultStartupService, DefaultStatusService, DefaultTableDisplay, DefaultTableIOPlugin, DefaultTableIOService, DefaultTaskService, DefaultTextDisplay, DefaultTextIOService, DefaultTextService, DefaultThreadService, DefaultToolService, DefaultUIService, DefaultValuePreprocessor, DefaultWelcomeService, DefaultWidgetModel, DefaultWidgetService, DisplayActivatedEvent, DisplayCreatedEvent, DisplayDeletedEvent, DisplayEvent, DisplayPostprocessor, DisplayUpdatedEvent, DragAndDropEvent, DragEnterEvent, DragExitEvent, DragOverEvent, DropEvent, DummyHandle, DummyTool, DynamicCommand, EasySwingDisplayViewer, ExportTableCommand, FileBatchInputProvider, FileBatchService, FileDragAndDropHandler, FileHandle, FileListConverters.FileArrayToStringConverter, FileListConverters.FileToStringConverter, FileListConverters.StringToFileArrayConverter, FileListConverters.StringToFileConverter, FileListPreprocessor, FileLocationResolver, FilePreprocessor, FileScriptBatchProcessor, GatewayPreprocessor, GroovyScriptLanguage, GuavaCacheService, HeadlessArgument, HeadlessDisplayViewer, HeadlessUI, HeadlessUI, HTTPHandle, HTTPLocationResolver, InitPreprocessor, InputEvent, Inputs, InteractiveCommand, IOEvent, JavaScriptLanguage, JavaScriptScriptLanguage, JRubyScriptHeader, JRubyScriptLanguage, JythonScriptLanguage, KillScript, KotlinScriptLanguage, KyEvent, KyPressedEvent, KyReleasedEvent, KyTypedEvent, ListDragAndDropHandler, ListEvent, LoadInputsPreprocessor, LoggerPreprocessor, MainArgument, MainCodeRunner, MarkdownTextFormat, MATLABOptions, MATLABScriptLanguage, MenuEvent, MenusAddedEvent, MenuScriptBatchProcessor, MenusRemovedEvent, MenusUpdatedEvent, ModuleBatchProcessor, ModuleCanceledEvent, ModuleCodeRunner, ModuleCommand, ModuleEvent, ModuleExecutedEvent, ModuleExecutingEvent, ModuleExecutionEvent, ModuleFinishedEvent, ModulePostprocessEvent, ModulePreprocessEvent, ModuleProcessEvent, ModuleRunner, ModulesAddedEvent, ModulesListEvent, ModulesRemovedEvent, ModuleStartedEvent, ModulesUpdatedEvent, MsButtonEvent, MsClickedEvent, MsDraggedEvent, MsEnteredEvent, MsEvent, MsExitedEvent, MsMovedEvent, MsPressedEvent, MsReleasedEvent, MsWheelEvent, MultiWriteHandle, NullConverter, NumberConverters.BigIntegerToBigDecimalConverter, NumberConverters.ByteToBigDecimalConverter, NumberConverters.ByteToBigIntegerConverter, NumberConverters.ByteToDoubleConverter, NumberConverters.ByteToFloatConverter, NumberConverters.ByteToIntegerConverter, NumberConverters.ByteToLongConverter, NumberConverters.ByteToShortConverter, NumberConverters.DoubleToBigDecimalConverter, NumberConverters.FloatToBigDecimalConverter, NumberConverters.FloatToDoubleConverter, NumberConverters.IntegerToBigDecimalConverter, NumberConverters.IntegerToBigIntegerConverter, NumberConverters.IntegerToDoubleConverter, NumberConverters.IntegerToLongConverter, NumberConverters.LongToBigDecimalConverter, NumberConverters.LongToBigIntegerConverter, NumberConverters.ShortToBigDecimalConverter, NumberConverters.ShortToBigIntegerConverter, NumberConverters.ShortToDoubleConverter, NumberConverters.ShortToFloatConverter, NumberConverters.ShortToIntegerConverter, NumberConverters.ShortToLongConverter, NumberToBigDecimalConverter, NumberToBigIntegerConverter, NumberToDoubleConverter, NumberToFloatConverter, NumberToIntegerConverter, NumberToLongConverter, NumberToNumberConverter, NumberToShortConverter, ObjectCreatedEvent, ObjectDeletedEvent, ObjectEvent, ObjectModifiedEvent, ObjectsAddedEvent, ObjectsListEvent, ObjectsRemovedEvent, OpenArgument, OpenFile, OptionsEvent, OptionsLookAndFeel, OptionsPlugin, OutputEvent, ParamAssignOrder, PlainTextFormat, PluginsAddedEvent, PluginsListEvent, PluginsRemovedEvent, PrimitiveArrayUnwrapper, PrimitiveArrayWrapper, ReadBufferDataHandle, RenjinScriptLanguage, ResultsPostprocessor, RunArgument, RunArgument, RunScript, RunScriptArgument, SaveInputsPreprocessor, ScalaScriptLanguage, SciJava, SciJavaApp, SciJavaEvent, ScriptCodeRunner, ScriptFileDragAndDropHandler, ScriptFinder, ScriptInfo, ScriptIOPlugin, ScriptModule, ServiceHelper, ServicePreprocessor, ServicesLoadedEvent, ShadowMenu, ShowUIArgument, SLF4JLogService, SortablePlugin, StatusEvent, StderrLogService, SwingButtonWidget, SwingChoiceRadioWidget, SwingChoiceWidget, SwingColorWidget, SwingDateWidget, SwingFileListWidget, SwingFileWidget, SwingIconService, SwingInputHarvester, SwingInputWidget, SwingMdiInputHarvester, SwingMdiUI, SwingMessageWidget, SwingNumberWidget, SwingObjectWidget, SwingScriptInfoWidget, SwingSDIUI, SwingTableDisplayViewer, SwingTextDisplayViewer, SwingTextWidget, SwingToggleWidget, SystemPropertyArgument, TaskEvent, TextIOPlugin, ToolActivatedEvent, ToolDeactivatedEvent, ToolEvent, UIArgument, UIEvent, UIPreprocessor, UIShownEvent, UnimplementedCommand, ValidityPreprocessor, WelcomeEvent, WinActivatedEvent, WinClosedEvent, WinClosingEvent, WinDeactivatedEvent, WinDeiconifiedEvent, WinEvent, WinIconifiedEvent, WinOpenedEvent, WriteBufferDataHandle
```
public interface Contextual
```
An object that belongs to a SciJava application context.

Author:

Lee Kamentsky, Curtis Rueden

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Context`	`context()` Gets the application context to which the object belongs.
`Context`	`getContext()` Gets the application context to which the object belongs, or null if `setContext(Context)` has not yet been called on this object.
`default void`	`setContext(Context context)` Sets the application context to which the object belongs.

- Method Detail
  - context
```
Context context()
```
    Gets the application context to which the object belongs.
    
    Throws:
    
    NullContextException - if the context has not yet been set via setContext(Context).
    
    See Also:
    
    getContext()
  - getContext
```
Context getContext()
```
    Gets the application context to which the object belongs, or null if setContext(Context) has not yet been called on this object.
    
    See Also:
    
    context()
  - setContext
```
default void setContext(Context context)
```
    Sets the application context to which the object belongs.
    Typically this method simply delegates to Context.inject(Object), and should be called only once to populate the context. Most contextual objects do not support later alteration of the context, and will throw IllegalStateException if this method is invoked again.
    
    Throws:
    
    IllegalStateException - If the object already has a context.
    
    IllegalArgumentException - If the object has a required Service parameter (see Parameter.required()) which is not available from the context.
    
    See Also:
    
    Context.inject(Object)

Interface Contextual

Method Summary

Method Detail

context

getContext

setContext