com.diffplug.common.swt

Class SwtRx

java.lang.Object

com.diffplug.common.swt.SwtRx

public class SwtRx
extends Object

Utilities that convert SWT events into Rx-friendly Observables.

Constructor Summary

Constructors

Constructor and Description
SwtRx()

Method Summary

Modifier and Type	Method and Description
static Observable<Event>	addListener(Widget widget, Collection<Integer> events) Subscribes to the given widget and pipes the events to an Observable<Event>.
static Observable<Event>	addListener(Widget widget, int... events) Subscribes to the given widget and pipes the events to an Observable<Event>.
static Observable<Event>	addListener(Widget widget, Stream<Integer> events) Subscribes to the given widget and pipes the events to an Observable<Event>.
static com.diffplug.common.rx.Chit	chit(ControlWrapper wrapper) Wraps the given ControlWrapper in an Chit.
static com.diffplug.common.rx.Chit	chit(Widget guard) Wraps the given Widget in an Chit.
static <T> com.diffplug.common.rx.RxBox<T>	combo(Combo combo, ImmutableList<T> values, Function<T,String> converter) Populates a Combo returns an `RxBox` which is bidirectionally bound to the given combo.
static <T> void	combo(Combo combo, ImmutableList<T> values, Function<T,String> converter, com.diffplug.common.rx.RxBox<T> box) Populates a Combo and bidirectionally binds it to an `RxBox`.
static Observable<Point>	rightClickGlobal(Control ctl) Returns an Observable<Point> of the right-click mouse-up on the given control, in global coordinates.
static Observable<Point>	rightClickLocal(Control ctl) Returns an Observable<Point> of the right-click mouse-up on the given control, in local coordinates.
static com.diffplug.common.rx.RxBox<String>	textConfirmed(Text text) Returns an RxBox which contains the content of the text box only when it has been confirmed by: programmer setting the RxBox user hitting enter focus leaving the text
static com.diffplug.common.rx.RxBox<String>	textImmediate(Text text) Returns an RxBox which contains the content of the text box.
static com.diffplug.common.rx.RxBox<Boolean>	toggle(Button btn) Returns an `RxBox` for the toggle state of the given button as an RxBox.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SwtRx

public SwtRx()

Method Detail

addListener

public static Observable<Event> addListener(Widget widget,
                                            int... events)

Subscribes to the given widget and pipes the events to an Observable<Event>.

addListener

public static Observable<Event> addListener(Widget widget,
                                            Collection<Integer> events)

Subscribes to the given widget and pipes the events to an Observable<Event>.

addListener

public static Observable<Event> addListener(Widget widget,
                                            Stream<Integer> events)

Subscribes to the given widget and pipes the events to an Observable<Event>.

rightClickGlobal

public static Observable<Point> rightClickGlobal(Control ctl)

Returns an Observable<Point> of the right-click mouse-up on the given control, in global coordinates.

rightClickLocal

public static Observable<Point> rightClickLocal(Control ctl)

Returns an Observable<Point> of the right-click mouse-up on the given control, in local coordinates.

textImmediate

public static com.diffplug.common.rx.RxBox<String> textImmediate(Text text)

Returns an RxBox which contains the content of the text box.

textConfirmed

public static com.diffplug.common.rx.RxBox<String> textConfirmed(Text text)

Returns an RxBox which contains the content of the text box only when it has been confirmed by:

• programmer setting the RxBox
• user hitting enter
• focus leaving the text

toggle

public static com.diffplug.common.rx.RxBox<Boolean> toggle(Button btn)

Returns an `RxBox` for the toggle state of the given button as an RxBox.

Applicable to SWT.TOGGLE, SWT.CHECK, and SWT.RADIO.

combo

public static <T> com.diffplug.common.rx.RxBox<T> combo(Combo combo,
                                                        ImmutableList<T> values,
                                                        Function<T,String> converter)

Populates a Combo returns an `RxBox` which is bidirectionally bound to the given combo.

Parameters:

combo - The combo which is being bound.

values - The values which the RxBox can take on. Must match combo.getItems().

Returns:

An `RxBox` which is bound bidirectionally to the given combo.

combo

public static <T> void combo(Combo combo,
                             ImmutableList<T> values,
                             Function<T,String> converter,
                             com.diffplug.common.rx.RxBox<T> box)

Populates a Combo and bidirectionally binds it to an `RxBox`.

Parameters:

combo - The combo which is being bound.

values - The values which the RxBox can take on.

converter - A function for mapping values to strings.

values - The values which the RxBox can take on.

chit

public static com.diffplug.common.rx.Chit chit(ControlWrapper wrapper)

Wraps the given ControlWrapper in an Chit.

chit

public static com.diffplug.common.rx.Chit chit(Widget guard)

Wraps the given Widget in an Chit.