Package com.palantir.ptoss.cinch.swing

Annotation Interface Bound

@Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface Bound
Used to bind a UI control to a model property, where property is meant in a strict Java sense.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Bound.Utilities
    Inner utility class to simplify figuring out how to display null values in controls.
    static class 
    Bound.Wiring
    Inner utility class that performs the runtime wiring of all bindings in this package.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    to
    The property to bind to.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    events
    A hint as to what event should be used to listen to the component for changes.
    String
    nullValue
    Used to add a null value to a JComboBox.
    String[]
    on
    Specifies the ModelUpdates on which the binding will occur.
    String
    value
    Used for enum/boolean values for JRadioButtons and JToggleButtons.

  • Element Details

    • to

      String to
      The property to bind to.

    • on

      String[] on

      Specifies the ModelUpdates on which the binding will occur. Defaults to empty, which indicates all updates.

      Note: when bound to a specific ModelUpdate, a control will not receive not sent specifically to any ModelUpdate - i.e. default updates. To selectively answer a specific ModelUpdate and also still get default notications, add ModelUpdates.UNSPECIFIED to the list of ModelUpdates passed to on().

      See Also:
      Default:
      {""}

    • value

      String value
      Used for enum/boolean values for JRadioButtons and JToggleButtons. Valid values for booleans are "true", "false", and unset. When "true" the button will indicate a selected state, "false" indicates unselected state, and unset will indicate the state of the backing boolean.
      Default:
      ""

    • nullValue

      String nullValue
      Used to add a null value to a JComboBox.
      Default:
      ""

    • events

      String[] events
      A hint as to what event should be used to listen to the component for changes. Currently only used by the JTextComponentWiringHarness. Default is to use a document listener, which will fire the binding every time the document changes. Use event="actionPerformed" to use an ActionListener instead, or event="focusLost" to use focus loss.
      Default:
      {}