You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+2-4
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,6 @@
2
2
3
3
Pull requests are welcome, preferably against `master`.
4
4
5
-
Every successful Travis CI build on branch `master` is automatically published to [`https://oss.sonatype.org/content/repositories/snapshots`](https://oss.sonatype.org/content/repositories/snapshots/com/diffplug/), and its javadoc are published [here](http://diffplug.github.io/durian-swt/javadoc/snapshot/).
6
-
7
5
## Build instructions
8
6
9
7
It's a bog-standard gradle build.
@@ -30,13 +28,13 @@ By contributing your code, you agree to license your contribution under the term
30
28
All files are released with the Apache 2.0 license as such:
31
29
32
30
```
33
-
Copyright 2015 DiffPlug
31
+
Copyright 2020 DiffPlug
34
32
35
33
Licensed under the Apache License, Version 2.0 (the "License");
36
34
you may not use this file except in compliance with the License.
37
35
You may obtain a copy of the License at
38
36
39
-
http://www.apache.org/licenses/LICENSE-2.0
37
+
https://www.apache.org/licenses/LICENSE-2.0
40
38
41
39
Unless required by applicable law or agreed to in writing, software
42
40
distributed under the License is distributed on an "AS IS" BASIS,
*[`ControlWrapper`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/ControlWrapper.html) - create custom widgets which properly encapsulate their base control.
31
-
*[`Coat`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/Coat.html) - a functional interface for populating an empty Composite.
32
-
*[`CoatMux`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/CoatMux.html) - a mechanism for layering and swapping Coats.
33
-
*[`SwtExec`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/SwtExec.html) - an `ExecutorService` which executes on the SWT thread.
34
-
*[`SwtExec.Guarded`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/SwtExec.Guarded.html) - an `ExecutorService` which is tied to the lifetime of an SWT widget. Say goodbye to `SWTException: Widget is disposed` forever! It can also subscribe to any kind of observable (Guava's ListenableFuture or RxJava's Observable), see [DurianRx](https://github.com/diffplug/durian-rx) for more info.
28
+
*[`ControlWrapper`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/ControlWrapper.html) - create custom widgets which properly encapsulate their base control.
29
+
*[`Coat`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/Coat.html) - a functional interface for populating an empty Composite.
30
+
*[`CoatMux`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/CoatMux.html) - a mechanism for layering and swapping Coats.
31
+
*[`SwtExec`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/SwtExec.html) - an `ExecutorService` which executes on the SWT thread.
32
+
*[`SwtExec.Guarded`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/SwtExec.Guarded.html) - an `ExecutorService` which is tied to the lifetime of an SWT widget. Say goodbye to `SWTException: Widget is disposed` forever! It can also subscribe to any kind of observable (Guava's ListenableFuture or RxJava's Observable), see [DurianRx](https://github.com/diffplug/durian-rx) for more info.
*[`Actions`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/jface/Actions.html) - builder and one-liner:
70
+
*[`Actions`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/jface/Actions.html) - builder and one-liner:
73
71
`Actions.create("Redo", this::redo);`
74
72
75
-
*[`LabelProviders`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/jface/LabelProviders.html) - builder and one-liner:
73
+
*[`LabelProviders`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/jface/LabelProviders.html) - builder and one-liner:
76
74
`LabelProviders.createWithText(Person::getName)`
77
75
78
-
*[`ColumnFormat`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/ColumnFormat.html) and [`ColumnViewerFormat`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/jface/ColumnViewerFormat.html) - tables and trees without boilerplate
76
+
*[`ColumnFormat`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/ColumnFormat.html) and [`ColumnViewerFormat`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/jface/ColumnViewerFormat.html) - tables and trees without boilerplate
79
77
80
78
```java
81
79
ColumnViewerFormat<Person> format =ColumnViewerFormat.builder();
@@ -89,15 +87,15 @@ TreeViewer tree = format.buildTree(parent);
89
87
90
88
### Resource management
91
89
92
-
*[`OnePerWidget`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/OnePerWidget.html) - a cache tied to the lifetime of an SWT Widget.
93
-
*[`ColorPool`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/ColorPool.html) - a pool of colors tied to the lifetime of a widget. `ColorPool.forWidget(widget).getColor(rgbValue)`
94
-
*[`ImageDescriptors`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/jface/ImageDescriptors.html) - use ImageDescriptors with proper resource sharing. `ImageDescriptors.set(btn, imageDescriptor)`
90
+
*[`OnePerWidget`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/OnePerWidget.html) - a cache tied to the lifetime of an SWT Widget.
91
+
*[`ColorPool`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/ColorPool.html) - a pool of colors tied to the lifetime of a widget. `ColorPool.forWidget(widget).getColor(rgbValue)`
92
+
*[`ImageDescriptors`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/jface/ImageDescriptors.html) - use ImageDescriptors with proper resource sharing. `ImageDescriptors.set(btn, imageDescriptor)`
95
93
96
94
### Interactive testing
97
95
98
96
Ideally, all UI code would have fully automated UI testing, but
99
97
such tests are time-consuming to write, so they often just don't
100
-
get written at all. [`InteractiveTest`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/InteractiveTest.html)
98
+
get written at all. [`InteractiveTest`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/InteractiveTest.html)
101
99
bridges the gap by making it easy to write user-in-the-loop guided tests. Furthermore,
102
100
these tests can even be run in a [headless enviroment on a CI server](https://github.com/diffplug/durian-swt/blob/master/build.gradle#L66-L93), where the test UI
103
101
will be opened, then automatically closed after a timeout. This ensures that the tests
+`treeDefControl`, `treeDefComposite` - a [`TreeDef`](http://diffplug.github.io/durian/javadoc/snapshot/com/diffplug/common/base/TreeDef.html) for traversing UI elements.
137
135
+`setEnabledDeep` - sets the enabled status of every child, grandchild, etc. of the given composite.
138
-
*[`SwtRx`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/SwtRx.html) - methods for converting SWT events and models to RxJava Observables.
139
-
*[`SwtDebug`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/SwtDebug.html) - utilities for debugging SWT events.
140
-
*[`OS`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/os/OS.html), [`Arch`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/os/Arch.html), and [`SwtPlatform`](https://diffplug.github.io/durian-swt/javadoc/3.3.0/com/diffplug/common/swt/os/SwtPlatform.html) - detect things about the running system, and manipulate the SWT jars for build tools.
136
+
*[`SwtRx`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/SwtRx.html) - methods for converting SWT events and models to RxJava Observables.
137
+
*[`SwtDebug`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/SwtDebug.html) - utilities for debugging SWT events.
138
+
*[`OS`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/os/OS.html), [`Arch`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/os/Arch.html), and [`SwtPlatform`](https://javadoc.io/static/com.diffplug.durian/durian-swt/3.3.0/com/diffplug/common/swt/os/SwtPlatform.html) - detect things about the running system, and manipulate the SWT jars for build tools.
141
139
+ These do not require SWT or JFace, so you can add DurianSwt to your gradle or maven dependencies without needing to also figure out the SWT messiness.
142
140
+ You can also just copy-paste these straight into your own code - they have no external dependencies.
0 commit comments