Skip to content

Commit 130499d

Browse files
aaroncaaronc
committed
Initial commit.
0 parents  commit 130499d

File tree

7 files changed

+403
-0
lines changed

7 files changed

+403
-0
lines changed

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/target
2+
/classes
3+
/checkouts
4+
pom.xml
5+
pom.xml.asc
6+
*.jar
7+
*.class
8+
/.lein-*
9+
/.nrepl-port

‎LICENSE

+214
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
2+
LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM
3+
CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
4+
5+
1. DEFINITIONS
6+
7+
"Contribution" means:
8+
9+
a) in the case of the initial Contributor, the initial code and
10+
documentation distributed under this Agreement, and
11+
12+
b) in the case of each subsequent Contributor:
13+
14+
i) changes to the Program, and
15+
16+
ii) additions to the Program;
17+
18+
where such changes and/or additions to the Program originate from and are
19+
distributed by that particular Contributor. A Contribution 'originates' from
20+
a Contributor if it was added to the Program by such Contributor itself or
21+
anyone acting on such Contributor's behalf. Contributions do not include
22+
additions to the Program which: (i) are separate modules of software
23+
distributed in conjunction with the Program under their own license
24+
agreement, and (ii) are not derivative works of the Program.
25+
26+
"Contributor" means any person or entity that distributes the Program.
27+
28+
"Licensed Patents" mean patent claims licensable by a Contributor which are
29+
necessarily infringed by the use or sale of its Contribution alone or when
30+
combined with the Program.
31+
32+
"Program" means the Contributions distributed in accordance with this
33+
Agreement.
34+
35+
"Recipient" means anyone who receives the Program under this Agreement,
36+
including all Contributors.
37+
38+
2. GRANT OF RIGHTS
39+
40+
a) Subject to the terms of this Agreement, each Contributor hereby grants
41+
Recipient a non-exclusive, worldwide, royalty-free copyright license to
42+
reproduce, prepare derivative works of, publicly display, publicly perform,
43+
distribute and sublicense the Contribution of such Contributor, if any, and
44+
such derivative works, in source code and object code form.
45+
46+
b) Subject to the terms of this Agreement, each Contributor hereby grants
47+
Recipient a non-exclusive, worldwide, royalty-free patent license under
48+
Licensed Patents to make, use, sell, offer to sell, import and otherwise
49+
transfer the Contribution of such Contributor, if any, in source code and
50+
object code form. This patent license shall apply to the combination of the
51+
Contribution and the Program if, at the time the Contribution is added by the
52+
Contributor, such addition of the Contribution causes such combination to be
53+
covered by the Licensed Patents. The patent license shall not apply to any
54+
other combinations which include the Contribution. No hardware per se is
55+
licensed hereunder.
56+
57+
c) Recipient understands that although each Contributor grants the licenses
58+
to its Contributions set forth herein, no assurances are provided by any
59+
Contributor that the Program does not infringe the patent or other
60+
intellectual property rights of any other entity. Each Contributor disclaims
61+
any liability to Recipient for claims brought by any other entity based on
62+
infringement of intellectual property rights or otherwise. As a condition to
63+
exercising the rights and licenses granted hereunder, each Recipient hereby
64+
assumes sole responsibility to secure any other intellectual property rights
65+
needed, if any. For example, if a third party patent license is required to
66+
allow Recipient to distribute the Program, it is Recipient's responsibility
67+
to acquire that license before distributing the Program.
68+
69+
d) Each Contributor represents that to its knowledge it has sufficient
70+
copyright rights in its Contribution, if any, to grant the copyright license
71+
set forth in this Agreement.
72+
73+
3. REQUIREMENTS
74+
75+
A Contributor may choose to distribute the Program in object code form under
76+
its own license agreement, provided that:
77+
78+
a) it complies with the terms and conditions of this Agreement; and
79+
80+
b) its license agreement:
81+
82+
i) effectively disclaims on behalf of all Contributors all warranties and
83+
conditions, express and implied, including warranties or conditions of title
84+
and non-infringement, and implied warranties or conditions of merchantability
85+
and fitness for a particular purpose;
86+
87+
ii) effectively excludes on behalf of all Contributors all liability for
88+
damages, including direct, indirect, special, incidental and consequential
89+
damages, such as lost profits;
90+
91+
iii) states that any provisions which differ from this Agreement are offered
92+
by that Contributor alone and not by any other party; and
93+
94+
iv) states that source code for the Program is available from such
95+
Contributor, and informs licensees how to obtain it in a reasonable manner on
96+
or through a medium customarily used for software exchange.
97+
98+
When the Program is made available in source code form:
99+
100+
a) it must be made available under this Agreement; and
101+
102+
b) a copy of this Agreement must be included with each copy of the Program.
103+
104+
Contributors may not remove or alter any copyright notices contained within
105+
the Program.
106+
107+
Each Contributor must identify itself as the originator of its Contribution,
108+
if any, in a manner that reasonably allows subsequent Recipients to identify
109+
the originator of the Contribution.
110+
111+
4. COMMERCIAL DISTRIBUTION
112+
113+
Commercial distributors of software may accept certain responsibilities with
114+
respect to end users, business partners and the like. While this license is
115+
intended to facilitate the commercial use of the Program, the Contributor who
116+
includes the Program in a commercial product offering should do so in a
117+
manner which does not create potential liability for other Contributors.
118+
Therefore, if a Contributor includes the Program in a commercial product
119+
offering, such Contributor ("Commercial Contributor") hereby agrees to defend
120+
and indemnify every other Contributor ("Indemnified Contributor") against any
121+
losses, damages and costs (collectively "Losses") arising from claims,
122+
lawsuits and other legal actions brought by a third party against the
123+
Indemnified Contributor to the extent caused by the acts or omissions of such
124+
Commercial Contributor in connection with its distribution of the Program in
125+
a commercial product offering. The obligations in this section do not apply
126+
to any claims or Losses relating to any actual or alleged intellectual
127+
property infringement. In order to qualify, an Indemnified Contributor must:
128+
a) promptly notify the Commercial Contributor in writing of such claim, and
129+
b) allow the Commercial Contributor tocontrol, and cooperate with the
130+
Commercial Contributor in, the defense and any related settlement
131+
negotiations. The Indemnified Contributor may participate in any such claim
132+
at its own expense.
133+
134+
For example, a Contributor might include the Program in a commercial product
135+
offering, Product X. That Contributor is then a Commercial Contributor. If
136+
that Commercial Contributor then makes performance claims, or offers
137+
warranties related to Product X, those performance claims and warranties are
138+
such Commercial Contributor's responsibility alone. Under this section, the
139+
Commercial Contributor would have to defend claims against the other
140+
Contributors related to those performance claims and warranties, and if a
141+
court requires any other Contributor to pay any damages as a result, the
142+
Commercial Contributor must pay those damages.
143+
144+
5. NO WARRANTY
145+
146+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON
147+
AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER
148+
EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
149+
CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A
150+
PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the
151+
appropriateness of using and distributing the Program and assumes all risks
152+
associated with its exercise of rights under this Agreement , including but
153+
not limited to the risks and costs of program errors, compliance with
154+
applicable laws, damage to or loss of data, programs or equipment, and
155+
unavailability or interruption of operations.
156+
157+
6. DISCLAIMER OF LIABILITY
158+
159+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY
160+
CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL,
161+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
162+
LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
163+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
164+
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
165+
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY
166+
OF SUCH DAMAGES.
167+
168+
7. GENERAL
169+
170+
If any provision of this Agreement is invalid or unenforceable under
171+
applicable law, it shall not affect the validity or enforceability of the
172+
remainder of the terms of this Agreement, and without further action by the
173+
parties hereto, such provision shall be reformed to the minimum extent
174+
necessary to make such provision valid and enforceable.
175+
176+
If Recipient institutes patent litigation against any entity (including a
177+
cross-claim or counterclaim in a lawsuit) alleging that the Program itself
178+
(excluding combinations of the Program with other software or hardware)
179+
infringes such Recipient's patent(s), then such Recipient's rights granted
180+
under Section 2(b) shall terminate as of the date such litigation is filed.
181+
182+
All Recipient's rights under this Agreement shall terminate if it fails to
183+
comply with any of the material terms or conditions of this Agreement and
184+
does not cure such failure in a reasonable period of time after becoming
185+
aware of such noncompliance. If all Recipient's rights under this Agreement
186+
terminate, Recipient agrees to cease use and distribution of the Program as
187+
soon as reasonably practicable. However, Recipient's obligations under this
188+
Agreement and any licenses granted by Recipient relating to the Program shall
189+
continue and survive.
190+
191+
Everyone is permitted to copy and distribute copies of this Agreement, but in
192+
order to avoid inconsistency the Agreement is copyrighted and may only be
193+
modified in the following manner. The Agreement Steward reserves the right to
194+
publish new versions (including revisions) of this Agreement from time to
195+
time. No one other than the Agreement Steward has the right to modify this
196+
Agreement. The Eclipse Foundation is the initial Agreement Steward. The
197+
Eclipse Foundation may assign the responsibility to serve as the Agreement
198+
Steward to a suitable separate entity. Each new version of the Agreement will
199+
be given a distinguishing version number. The Program (including
200+
Contributions) may always be distributed subject to the version of the
201+
Agreement under which it was received. In addition, after a new version of
202+
the Agreement is published, Contributor may elect to distribute the Program
203+
(including its Contributions) under the new version. Except as expressly
204+
stated in Sections 2(a) and 2(b) above, Recipient receives no rights or
205+
licenses to the intellectual property of any Contributor under this
206+
Agreement, whether expressly, by implication, estoppel or otherwise. All
207+
rights in the Program not expressly granted under this Agreement are
208+
reserved.
209+
210+
This Agreement is governed by the laws of the State of New York and the
211+
intellectual property laws of the United States of America. No party to this
212+
Agreement will bring a legal action under this Agreement more than one year
213+
after the cause of action arose. Each party waives its rights to a jury trial
214+
in any resulting litigation.

‎README.md

+158
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
# fx-clj
2+
3+
WORK IN PROGRESS. Not ready yet!
4+
5+
A Clojure library for JavaFX with the following goals:
6+
7+
- Provide convenience functions for creating and modifying JavaFX
8+
objects without attempting to completely hide the JavaFX API
9+
- Work with **core.async** out of the box
10+
- Provide support for creating JavaFX functions with both a function
11+
based - `(fx/h-box (fx/button "Hello World"))` - and hiccup-like API -
12+
`(fx/compile [:h-box [:button "Hello World"]])`.
13+
14+
## Quick Start
15+
16+
Leiningen dependeny information:
17+
18+
COMING SOON.
19+
20+
21+
Two minute example:
22+
```clojure
23+
(ns example
24+
(:require [fx-clj.all :as fx]))
25+
26+
(defn create-view []
27+
(fx/h-box
28+
(fx/button {:on-action (fn [e] (println "Hello World"))
29+
:text "Click Me!"})))
30+
31+
(fx/sandbox #'create-view) ;; Creates a "sandbox" JavaFX window to
32+
;; show the view. Clicking F5 in this
33+
;; window will refresh the view allowing the
34+
;; create-view function to be updated at the REPL
35+
36+
```
37+
38+
Two minute core.async example:
39+
```clojure
40+
(ns example
41+
(:require [fx-clj.all :as fx])
42+
(:require [clojure.core.async :as async]))
43+
44+
45+
(defn create-view []
46+
(let [click-ch (async/chan))
47+
btn (fx/button {:on-action click-ch ;; You can bind a core.async channel directly to an event
48+
:text "Click Me!"}))]
49+
50+
(go
51+
(<! click-ch)
52+
(println "Clicked the first time")
53+
(<! click-ch)
54+
(println "Clicked again")
55+
(pset<! btn "Done")
56+
(println "Done listening to clicks))
57+
58+
(fx/h-box btn))))
59+
60+
61+
(fx/sandbox #'create-view)
62+
```
63+
64+
## Usage
65+
66+
To get all of fx-clj into your namespace quickly use a namespace
67+
declaration like this:
68+
```clojure
69+
(ns my-ns
70+
(:require [fx-clj.all :as fx]))
71+
```
72+
73+
To use fx-clj and core.async together, use something like this:
74+
```clojure
75+
(ns my-ns
76+
(:require [fx-clj.all :as fx])
77+
(:require [clojure.core.async :as async :refer [go go-loop chan <! >!])))
78+
```
79+
80+
### Interacting with the JavaFX application thread
81+
82+
There are three macros for interacting with the JavaFX application
83+
thread - each providing slightly different asynchronous behavior:
84+
`run!`, `run<!` and `run<!!`. For those familiar with core.async, these
85+
correspond roughly to the behavior of `put!`, `<!` and `<!!`
86+
respectively.
87+
88+
`run!` send a block of code to be run asynchronously on the JavaFX
89+
application thread without blocking the caller. (It is effectively a
90+
thin wrapper around javafx.application.Platform/runLater.)
91+
92+
```clojure
93+
(run! (do-something)) ;; run asynchously without blocking
94+
```
95+
96+
`run<!` *can only be used in a core.async* `go` *block!* It uses a
97+
core.async channel and `<!` to return the value of the code executed
98+
on the JavaFX application thread to the caller in `go` block. (This
99+
blocks the `go` block, but does not block a thread.)
100+
101+
```clojure
102+
(go
103+
(let [res (run<! (do-something))] ;; Go block paused
104+
(println res)))
105+
```
106+
107+
`run<!!` uses a core.async channel and `<!!` to return the value of
108+
the code executed on the JavaFX application thread. It blocks the
109+
calling thread to return its value.
110+
111+
```clojure
112+
(let [res (run<!! (do-something))] ;; Calling thread blocked
113+
(println res)))
114+
```
115+
116+
### Modifying JavaFX objects
117+
118+
The pset macros are used to modify JavaFX objects. Like the run
119+
macros, there are 3 variants: `pset!`, `pset<!`, and `pset<!!` which
120+
have the same async behavior. Note: In the case of the pset macros,
121+
this behavior is more for coordination between
122+
processes rather than for getting any actual return value (these
123+
macros return the value they were passed except that when `pset!` is called
124+
from a thread other than the JavaFX application thread it runs
125+
asynchronously without blocking the caller and returns `nil`).
126+
127+
TODO: maybe pset should always return `nil`??
128+
129+
### Creating JavaFX objects
130+
131+
There is both a function based and hiccup-style API for creating
132+
JavaFX objects.
133+
134+
See the API documentation for `fx-clj.elements` for a list of
135+
supported JavaFX objects.
136+
137+
The syntax for all object creation functions and the hiccup like
138+
vectors, is almost identical to the pset syntax. All of these are equivalent:
139+
140+
```clojure
141+
(pset! (Button.) :#my-btn.my-class {:on-action (fn [] (println "Clicked")) :text "Click Me} "Click Me")
142+
143+
(fx/button :#my-btn.my-class {:on-action (fn [] (println "Clicked"))} "Click Me")
144+
145+
(fx/compile [:button#my-btn.my-class {:on-action (fn [] (println "Clicked"))}] "Click Me")
146+
```
147+
148+
It is basically all a matter of what style you prefer.
149+
150+
Because the DefaultProperty of Button is `text`, it can be set as the
151+
argument after the property map.
152+
153+
## License
154+
155+
Copyright © 2014 FIXME
156+
157+
Distributed under the Eclipse Public License either version 1.0 or (at
158+
your option) any later version.

‎doc/intro.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Introduction to fx-clj
2+
3+
TODO: write [great documentation](http://jacobian.org/writing/what-to-write/)

‎project.clj

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(defproject fx-clj "0.1.0-SNAPSHOT"
2+
:description "FIXME: write description"
3+
:url "http://example.com/FIXME"
4+
:license {:name "Eclipse Public License"
5+
:url "http://www.eclipse.org/legal/epl-v10.html"}
6+
:dependencies [[org.clojure/clojure "1.6.0"]])

0 commit comments

Comments
 (0)