Package com.luciad.view

Class TLcdFXEventFilterBuilder

java.lang.Object
com.luciad.view.TLcdFXEventFilterBuilder
public final class TLcdFXEventFilterBuilder extends Object

A builder to create JavaFX Event filters. Event filters can be useful when constructing controller chains (see ALspController.setFXFilter(ILcdFilter)).

Filters can be combined using the operators and() and or(). By using openBrackets() and closeBrackets() it is possible to control which operators will be evaluated first. Operators between brackets will be evaluated before any others, otherwise and will be evaluated before or. For instance the following statement: 

    TLcdFXEventFilterBuilder
        .newBuilder()
        .openBrackets().leftMouseButton().or().rightMouseButton().closeBrackets()
        .and()
        .altFilter(true)
        .build();
will return a filter that will let both left or right mouse button events pass, but only if alt is down too. Without the brackets, left mouse button events would always pass but right mouse button events only when alt is down.

The AWT equivalent of this class is TLcdAWTEventFilterBuilder.

Since:
2020.0

  • Method Details

    • newBuilder

      public static TLcdFXEventFilterBuilder newBuilder()
      Returns a new JavaFX event filter builder.
      Returns:
      a new builder

    • or

      public TLcdFXEventFilterBuilder or()
      Operator to be called between two filter calls to indicate the event must pass one of the two filters.
      Returns:
      this builder.

    • and

      public TLcdFXEventFilterBuilder and()
      Operator to be called between two filter calls to indicate the event must pass both filters.
      Returns:
      this builder.

    • openBrackets

      public TLcdFXEventFilterBuilder openBrackets()
      Starts a new subfilter, all filters and operators called between this call and the next call to closeBrackets will be evaluated together before operators and filters outside the brackets are evaluated.
      Returns:
      the sub-filter.

    • closeBrackets

      public TLcdFXEventFilterBuilder closeBrackets()
      Ends a new subfilter, all filters and operators called between this call and the previous call to openBrackets will be evaluated together before operators and filters outside the brackets are evaluated.
      Returns:
      the parent of the current sub-filter.

    • build

      public ILcdFilter<Event> build()
      Builds the filter.
      Returns:
      an Event filter.

    • customFilter

      public TLcdFXEventFilterBuilder customFilter(ILcdFilter<Event> aFilter)
      Adds a custom filter.
      Parameters:
      aFilter - the filter to add to this builder.
      Returns:
      this builder.

    • leftMouseButton

      public TLcdFXEventFilterBuilder leftMouseButton()
      Adds a left mouse button filter. On macOS, this does not filter ctrl + left mouse button, because this is interpreted as a right mouse button.
      Returns:
      this builder.

    • middleMouseButton

      public TLcdFXEventFilterBuilder middleMouseButton()
      Adds a middle mouse button filter.
      Returns:
      this builder.

    • rightMouseButton

      public TLcdFXEventFilterBuilder rightMouseButton()
      Adds a right mouse button filter. On macOS, this also filters ctrl + left mouse button.
      Returns:
      this builder.

    • ctrlFilter

      public TLcdFXEventFilterBuilder ctrlFilter(boolean aCtrlDown)
      Adds a ctrl (cmd on macOS) down InputEvent filter.
      Parameters:
      aCtrlDown - if true only events with a ctrl down mask pass, otherwise only events without ctrl down mask.
      Returns:
      this builder.

    • altFilter

      public TLcdFXEventFilterBuilder altFilter(boolean aAltDown)
      Adds a alt down InputEvent filter.
      Parameters:
      aAltDown - if true only events with a alt down mask pass, otherwise only events without alt down mask.
      Returns:
      this builder.

    • shiftFilter

      public TLcdFXEventFilterBuilder shiftFilter(boolean aShiftDown)
      Adds a shift down InputEvent filter.
      Parameters:
      aShiftDown - if true only events with a shift down mask pass, otherwise only events without shift down mask.
      Returns:
      this builder.

    • mouseWheelFilter

      public TLcdFXEventFilterBuilder mouseWheelFilter()
      A filter that only allows mouse wheel events to pass.
      Returns:
      this builder.

    • touchEvents

      public TLcdFXEventFilterBuilder touchEvents()
      A filter that only allows touch events to pass.
      Returns:
      this builder.

    • mouseEvents

      public TLcdFXEventFilterBuilder mouseEvents()
      A filter that only allows mouse and scroll events to pass.
      Returns:
      this builder.

    • keyEvents

      public TLcdFXEventFilterBuilder keyEvents()
      A filter that only allows key events to pass.
      Returns:
      this builder.