com.holonplatform.vaadin.navigator.internal

## Interface ViewContextField

- All Known Implementing Classes:
    DefaultViewContextField

      public interface ViewContextField

  A reference to a `ViewContext` annotated `Field`. For internal use.
  Since:
    5.0.0

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `static ViewContextField` | `build(String contextResourceKey, boolean required, Field field)` Build a ViewContextField
    `String` | `getContextResourceKey()` Optional context resource key to inject
    `Field` | `getField()` Field reference
    `boolean` | `isRequired()` Whether the context injection is required

- - ### Method Detail

    - #### getContextResourceKey

          String getContextResourceKey()

      Optional context resource key to inject
      Returns:
        Context resource key

    - #### isRequired

          boolean isRequired()

      Whether the context injection is required
      Returns:
        Required, defaults to `true`

    - #### getField

          Field getField()

      Field reference
      Returns:
        Field

    - #### build

          static ViewContextField build(String contextResourceKey,
                                        boolean required,
                                        Field field)

      Build a ViewContextField
      Parameters:
        `contextResourceKey` - Context resource key
        `required` - Required context injection
        `field` - Field reference
      Returns:
        ViewContextField

Copyright © 2019 The Holon Platform. All rights reserved.