Class TLspAWTEventFilterBuilder

java.lang.Object
com.luciad.view.lightspeed.controller.TLspAWTEventFilterBuilder

public class TLspAWTEventFilterBuilder extends Object
Deprecated.
TLcdAWTEventFilterBuilder offers identical functionality; use that class instead.

A builder to create typical AWTEvent filters. These 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:


   TLspAWTEventFilterBuilder.newBuilder().
    openBrackets().
    leftMouseButton().or().rightMouseButton().
    closeBrackets().
    and().altFilter().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.

Since:
2012.0
  • Constructor Details

    • TLspAWTEventFilterBuilder

      protected TLspAWTEventFilterBuilder()
      Deprecated.
      Constructor to use when extending from this class.
  • Method Details

    • newBuilder

      public static TLspAWTEventFilterBuilder newBuilder()
      Deprecated.
      Returns:
      a new builder
    • or

      Deprecated.
      Operator to be called between two filter calls to indicate the event must pass one of the two filters.
      Returns:
      this builder.
    • and

      Deprecated.
      Operator to be called between two filter calls to indicate the event must pass both filters.
      Returns:
      this builder.
    • openBrackets

      public TLspAWTEventFilterBuilder openBrackets()
      Deprecated.
      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 TLspAWTEventFilterBuilder closeBrackets()
      Deprecated.
      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<AWTEvent> build()
      Deprecated.
      Builds the filter.
      Returns:
      a AWTEvent filter.
    • customFilter

      public TLspAWTEventFilterBuilder customFilter(ILcdFilter<AWTEvent> aFilter)
      Deprecated.
      Adds a custom filter.
      Parameters:
      aFilter - the filter to add to this builder.
      Returns:
      this builder.
    • leftMouseButton

      public TLspAWTEventFilterBuilder leftMouseButton()
      Deprecated.
      Adds a left mouse button filter.
      Returns:
      this builder.
    • middleMouseButton

      public TLspAWTEventFilterBuilder middleMouseButton()
      Deprecated.
      Adds a middle mouse button filter.
      Returns:
      this builder.
    • rightMouseButton

      public TLspAWTEventFilterBuilder rightMouseButton()
      Deprecated.
      Adds a right mouse button filter.
      Returns:
      this builder.
    • ctrlFilter

      public TLspAWTEventFilterBuilder ctrlFilter(boolean aCtrlDown)
      Deprecated.
      Adds a ctrl 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 TLspAWTEventFilterBuilder altFilter(boolean aAltDown)
      Deprecated.
      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 TLspAWTEventFilterBuilder shiftFilter(boolean aShiftDown)
      Deprecated.
      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 TLspAWTEventFilterBuilder mouseWheelFilter()
      Deprecated.
      A filter that only allows mouse wheel events to pass.
      Returns:
      this builder.
    • touchEvents

      public TLspAWTEventFilterBuilder touchEvents()
      Deprecated.
      A filter that only allows touch events to pass.
      Returns:
      this builder.
    • mouseEvents

      public TLspAWTEventFilterBuilder mouseEvents()
      Deprecated.
      A filter that only allows mouse events to pass.
      Returns:
      this builder.
    • keyEvents

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