UiContextReference (Magnolia UI (parent) 6.2.3 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

UiContextReference.AppContextReference, UiContextReference.DatasourceComponentContextReference, UiContextReference.SubAppContextReference, UiContextReference.UiContextReferenceImpl, UiContextReference.ViewContextReference
```
public interface UiContextReference
extends Serializable
```
A simple abstraction for the UI context identification. Useful in the two following scenarios:
Used by SessionStore as the key of a BeanStore containing scoped objects (see method).

Helps to resolve the Guice Binding Annotation corresponding to the UI context, which provides access to context-specific type bindings (orchestrated by e.g. UiContextApplyingProvider).

Also provides a list of the keys that are more 'general' than the current.

See Also:

UiContextApplyingProvider, CurrentUiContextReference, SessionStore, UiScopes

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`UiContextReference.AppContextReference` App specific UI context reference.
`static class`	`UiContextReference.DatasourceComponentContextReference` Datasource-specific component reference implementation.
`static class`	`UiContextReference.SubAppContextReference` Sub-app specific UI context reference.
`static class`	`UiContextReference.UiContextReferenceImpl` Base `UiContextReference` implementation.
`static class`	`UiContextReference.ViewContextReference` View-specific UI context reference implementation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`String`	`asString()` Get String representation of UI context ref; useful when the reference needs to be used as a key in a hash map (e.g.
`static UiContextReference`	`genericAppContextReference()`
`static UiContextReference`	`genericSubAppContextReference()`
`static UiContextReference`	`genericViewContextReference()`
`UiContextAnnotation`	`getAnnotation()` Get `UiContextAnnotation` which corresponds to this UI context reference.
`default Optional<UiContextReference>`	`getDirectParentReference()`
`default List<UiContextReference>`	`getParentReferences()` Get all the ('broader') references that can be resolved from the current one.
`static UiContextReference`	`ofApp(AppContext appContext)` Creates a UI context reference bound to a concrete instance of an app.
`static UiContextReference`	`ofCurrentUi()`
`static UiContextReference`	`ofDatasourceComponent(String datasourceId)`
`static UiContextReference`	`ofM5Admincentral()`
`static UiContextReference`	`ofSubApp(SubAppContext subAppContext)` Creates a UI context reference bound to a concrete instance of a sub-app.
`static UiContextReference`	`ofUi(com.vaadin.ui.UI ui)`
`static UiContextReference`	`ofView(String viewId, UiContextReference parentKey)`

- Method Detail
  - asString
```
String asString()
```
    Get String representation of UI context ref; useful when the reference needs to be used as a key in a hash map (e.g. in BeanStore).
  - getAnnotation
```
UiContextAnnotation getAnnotation()
```
    Get UiContextAnnotation which corresponds to this UI context reference. Such annotation is also a BindingAnnotation used by Guice.
  - getParentReferences
```
default List<UiContextReference> getParentReferences()
```
    Get all the ('broader') references that can be resolved from the current one.
  - getDirectParentReference
```
default Optional<UiContextReference> getDirectParentReference()
```
  - ofUi
```
static UiContextReference ofUi(com.vaadin.ui.UI ui)
```
  - ofM5Admincentral
```
static UiContextReference ofM5Admincentral()
```
  - ofCurrentUi
```
static UiContextReference ofCurrentUi()
```
  - ofApp
```
static UiContextReference ofApp(AppContext appContext)
```
    Creates a UI context reference bound to a concrete instance of an app. All the app scoped objects relevant to that app will be resolvable through this reference.
    
    Parameters:
    
    appContext - concrete instance of a app context
    
    Returns:
    
    ui context reference bound to the app instance
  - ofSubApp
```
static UiContextReference ofSubApp(SubAppContext subAppContext)
```
    Creates a UI context reference bound to a concrete instance of a sub-app. All the scoped objects relevant to that sub-app will be resolvable through this reference.
    
    Parameters:
    
    subAppContext - concrete instance of a sub-app context
    
    Returns:
    
    ui context reference bound to sub-app instance
  - ofView
```
static UiContextReference ofView(String viewId,
                                 UiContextReference parentKey)
```
  - ofDatasourceComponent
```
static UiContextReference ofDatasourceComponent(String datasourceId)
```
  - genericSubAppContextReference
```
static UiContextReference genericSubAppContextReference()
```
  - genericAppContextReference
```
static UiContextReference genericAppContextReference()
```
  - genericViewContextReference
```
static UiContextReference genericViewContextReference()
```

Interface UiContextReference

Nested Class Summary

Method Summary

Method Detail

asString

getAnnotation

getParentReferences

getDirectParentReference

ofUi

ofM5Admincentral

ofCurrentUi

ofApp

ofSubApp

ofView

ofDatasourceComponent

genericSubAppContextReference

genericAppContextReference

genericViewContextReference