From ce2487fee4a7d856011c17b985457a0bdc2745da Mon Sep 17 00:00:00 2001 From: Marco Trombino Date: Sat, 16 Dec 2017 20:52:08 +0100 Subject: [PATCH] Project setup --- .gitignore | 3 + LICENSE | 674 ++++++++++++++++++++++++++ README.md | 122 +++++ fxrouterlogo.png | Bin 0 -> 22411 bytes src/com/github/fxrouter/FXRouter.java | 282 +++++++++++ 5 files changed, 1081 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 fxrouterlogo.png create mode 100644 src/com/github/fxrouter/FXRouter.java diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6849349 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +out +.idea +*.iml \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..549e31a --- /dev/null +++ b/README.md @@ -0,0 +1,122 @@ +

+ +# FXRouter +A simple JavaFX router to switch between application scenes + +[Example](#example) +### Advantages +You can switch between your scenes from anywhere through a simple method, without worrying about annoying Stage settings. + +## Usage +### 1. Bind +Import FXRouter from its package: +```java + import myAppPackage.FXRouter; +``` +Connect FXRouter to your application stage: call `bind()` from your main class `start()` method (if you use IntelliJ IDEA) or similar: +```java +FXRouter.bind(this, primaryStage); +``` + ##### You can optionally set application title and size (width, height): +```java +FXRouter.bind(this, primaryStage, "MyApplication", 800, 600); +``` +### 2. Set routes +Define your Application routes with a label identifier and its corresponding .fxml screen file: +```java +FXRouter.when("login", "myloginscreen.fxml"); +FXRouter.when("profile", "myprofilescreen.fxml"); +// ... others +``` +##### You can optionally specify the route title and size (width, height): +```java +FXRouter.when("login", "myloginscreen.fxml", "My login screen", 1000, 500); +``` +### 3. Switch +Switch routes from anywhere (controllers, services, etc): +```java +FXRouter.goTo("login"); // switch to myloginscreen.fxml +``` + + +### Passing and retrieving data between routes +Your application could need to pass some data to another route and then retrieve those data: +#### Send data from the current scene +`goTo()` accepts two parameters: a route identifier and a `Object`: +##### (Multiples data could be stored on an appropriate Collection) +```java +FXRouter.goTo("profile", "johndoe22"); // switch to myprofilescreen.fxml passing an username +``` +#### Get data from the destination scene +`getData()` returns a `Object` which can be cast to appropriate data type: +```java +String username = (String) FXRouter.getData(); // retrieve johndoe22 +``` + +## Example +#### Without FXRouter +A common JavaFX project starter: +```java +package sample; + +import javafx.application.Application; +import javafx.fxml.FXMLLoader; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.stage.Stage; + +public class Main extends Application { + + @Override + public void start(Stage primaryStage) throws Exception{ + Parent root = FXMLLoader.load(getClass().getResource("sample.fxml")); + primaryStage.setTitle("Hello World"); + primaryStage.setScene(new Scene(root, 300, 275)); + primaryStage.show(); + } + + + public static void main(String[] args) { + launch(args); + } +} +``` + +#### Using FXRouter +```java +package sample; + +import javafx.application.Application; +import javafx.stage.Stage; +import sample.FXRouter; // import FXRouter + +public class Main extends Application { + + @Override + public void start(Stage primaryStage) throws Exception{ + + FXRouter.bind(this, primaryStage, "Hello World", 300, 275); // bind FXRouter + FXRouter.when("firstPage", "sample.fxml"); // set "firstPage" route + FXRouter.goTo("firstPage"); // switch to "sample.fxml" + } + + + public static void main(String[] args) { + launch(args); + } +} +``` + +### Switch animation +You can also set an animation type when you switch between routes: +```java +FXRouter.setAnimationType("fade"); +``` +##### You can optionally specify the animation duration (ms): +```java +FXRouter.setAnimationType("fade", 1200); +``` +#### animationType +| AnimationType | Default duration | +| ------------- | ------------- | +| `fade` | 800 | diff --git a/fxrouterlogo.png b/fxrouterlogo.png new file mode 100644 index 0000000000000000000000000000000000000000..546ba080e5be9d7bda27a8de8bcdfa7ca4da7b8a GIT binary patch literal 22411 zcmeI4c{tQv`0xj1-x9JL3}qerZe(A|PL_}{GcmT2UC0&@Std&n%ARFV_9gRB8A)1f zS)%L`9*K~8zp7`O=Xt!(d%eH+kN3LFb&c=$KKHrrbI#}7=X{s@8u6yadUVtr)F2Ru z&Ol$=95{CGeJRO-zwwV*4+94(Z+%-|5QygJ-j@WFb&CxIQhI^5wDGesI<1VrcuK&L z7-y73kf%3L8w65S5Aud1+);jDXOs)tOO1b}rJWy)Myl~!%Na=;d269u(fSvCP!<=B zEfE*p5lTpYbr`j3kTT%F6Xgd72YGsU`6>sg@qhQL44m&3L;1nqtN6LA@oVfg2(~dY z1#4k^P+&O;IdO!flq^_5NkU3aN>))y3@j}vB?Fa|flA4UOGztBDk)3Jfq#DZVbs8x zst@wKvbnbI&*lJ0jo;PJ&s!M^4GavF2$Ye)__#o&l$4a9lG0FVX>p*2xNoqRA3R9h z%U9rsli&PkqkIuQXm39>#tXdX7w(Ml_fzBN-)rdi&(CprdjH;#m+wz@07YmJ+#4z- zAqo8#BO{~z%{)E-(bCsXCjjWl&yoFOgT9u*-YBR!$`|ABgFxv7puGG9{;3m4#P5E* z{e3*X^Fbn@C=Zk;VB!mOUg{sa;O&a>!}z*l{$#Rx%LfJb!}wTYFdncUQD*vE@4;GH;1kwpFC-?=S6CHFT>Foy z{=*SU8}5gK0imb>1fjT;yrrbHvaF)AoPwyNl(MAcpPc-tN#w%_2zw;l5B^`g{G~3j z9}E(GKKMU*`J?7veHa-j8+iHp!MzYD18o>Eb_p~ZsVpfAN5K(tvf^?IO3va)q^y*< zGXm}`4o97rLP*LYkSHaE?}PlS`QKb?V-Ws(G4#_l5^yaGmzHvtRFoH&mywYccSgx7 ziYp=%QR2?h(kLm!c_}4@^UlAy{*(FNT$}iyflUbR@uxa_z5hRL;vd}nttox9FAzGx ze+nreu)c3I7N`qTWOKv$I4egXf()%RNe?!*^!-Y*dDgVJyT zV&Z?Z41YNMs|B%VRp{QH?1BD&FbBTyfd9K0_-{+-|MwaABX$w4a4#1W5(fP(Y=0~G zZhD(}Wi5;c#>WVQ zM8RZKq5o9;C#${dk20_~0C5Wcz9ywqp?@nQu5Yuq#y$MM*H@611U^uyy}v(A|Ewl9 zwcX$J&uU`RKP;`h(0(xKpRExU|H*3aBKZS`1#mxyg2~It$;hcfiHnIXOwmCo4;yVX zu%G+x?NY$i@23&5<{vF>|JCwOnxB?Gg5gj1Uf&n^k5b^y4!Eg={(e{ax3&NK?)X1> z^2d<=C%qE+I%tFl$o}F1uKoECX%BD_0oh+Xz_mXgBJBY#A|U&V2e|g>xMFeDj z@c`HUe2BCMxQKx4FCO69pAV7t02dLE{lx=Z`|}~v9^fJZvcGtMYkxjO+5=ofK=v08 zaP7~BNPB>b2+0280j~Y|5NQu^5dqm>JixU-A0q7mE+QcNiwC&&=R>4Dz(oXPfAIj< z{(OkE2e^oU>@ObR+Mf@R_5c?Vkp0C2T>JAO(jMR<0(zPS+ybWsoliiie*w!Q(!1rW$z5(HXw0)doofI!DE z*mI9`K_G5f18oh{6+8`83Ar2+pJU~5HHmH!u6eyF6j+@1b=)yCf|&amb!mll9sab z=~pxVDOBS?!_LN3z-Hx&(x&9tGOlc=e0!tnl2!ZmZq~(+kOi8qHA#IsaeSzgbT#xj z?K+4v;!1>Qq?bVP`XqHo<~Ic^{&=MA=$$h5Fy8iikOMe-ReuXd*8$w)%Fxr+rh)jFIKEtu4Wh}&`DNM*;$a@a+{`IdQ$#%yV64LHb6Tpvu7!Qi=4 zk`Q6Yv*)4edSM-^h!k+*F>mfkn>VV{@UjQ<7h>A3G`p0{3d&EgY*^`D)xFNl{YrKM zI{1Zq+7{?dhifYOiEGv6`*Ptc&a36pfM@E2QQ3)h(+3RsUoY_?*~w!eO+)+^ktA6? zCFEb|ogzeffPQ*6T7TT-upVC7+%*qt5JK7l)nfYjkB0K(IMv4U85B&ydNUw36d&0RCY6TrqP?nAL1mO7=$ zT-4H_GXMvQ&d%HGJ9@{oNxAYZzB#5jxK|b|evjGpr9G@Bmfycm_HHxKaUY$OJM&YU zu(#A9XNRQ+WRwH9;>(Qp8krRA-BiO>_uZ{C{p4XnP^P0bkS@`YI7I*4K9^gIrCFNZ z)SvSqrEe~T9qU1{ZPi#iz_M}s#^O9F`I*MrPL_c1S2ViUkvG8%Xi8E^;m2ius81H2 zl9E}F>xbCsT8o;#WQi^bIOA5VCcS%SqN6=5IoOP_@_svPZFn=P{y^sKVF&1qWni+i zSZ`7+6*Yy1F-6W;-W+n5SScDoIu)P22_`T)-Je|(vL5ba!i5V|Cnt&Fs#T1j>_+C8 z)@9!ham~+jYW=&eK>5_TU-8%{yUpDAiQpK3e?)}LX7B=SJ&E0x5q;3!L(f@&=RqXnt2C{ z%gN(R4d+FR-ohA%c@+-_kq5z&wR;5(xO!A58c9AYKIdKN>8Ja`W23L!?X^t)Rmb;3 zNQA}lUmNj7%?rG%Rl>D!h;&XpT_R}1lw(tTGQfH`fz|*kNZ7&)WC`mWt>*sh0`5*y zB>x;eYe!KXnDc0zuKZouB%;Q5(mRgi{hSWuYbTIF;sBx&Y@UgN7!UX$DGz7Yap z1Q`V_{_OW!u>vnj0^_1MHOE5IvbNc=4^?Aase`|z-T07V3wu>{fj#ZD;y}IOjiO5y z_BL@a53F%Em#aQgJ2&H#H>6)FnjjaYq*GlgT}g7w*Umf@`7*L`tFK?`M3N3JD@;5F zR!Os#7G1^Kuo6jVi{42sH|_&5keZOL#GIJp<~=*F>tq!>Q*T&zp?=o$D}D7jg0vo~ z3;(7%Os{b)S`hvYp1Vo0SjkhbhOZT`{w zWFSugMHBpn!m$KC!ZqC-@$KMg+~;5LU1>Q|A|(0G{9?ia9WQ5CH>90GS%-3kDMy!H z{&h5Y3$iM<^)SdOrtj0{01bFK)3oItMf(i(&LdSSu^~r%(#$7oi$W>kGv(PC(^QvU z5g@A;*28nNRyIvAlXui1D$)bKcBjKzL5DPUW4kQM+(lPsRB6f?=YW89r-&7@?>&VK zQ7>d|)nCiLo!|h^yXnHmGJ|~gP00T1V^XF=pR%#*a_>nV||2O*03ltG_fn4X=@WN6gaOwP40M|qqI$5{eGps^({HVM?TSrF6U6brKlwNm5LkW zn+?G9)lp8B#W=q;n1tkiV9h%!qhYMu9C9n+sqIVX$sNO?&65|IYe}wv1-iqnQs=m* z9lMevCLTV12eilS`9=xf$8TKMnonDnf4HRO=rGgUEt=;gXKAAE;4Agjt5JB_LUqgV z{FV^eyFT=1W+W^=ja`Mcn%Sso$YS0<%RgO5t;b|N>~Lf$jwV7+KprmpQXS3hP4`l% zS}6v`RkV0Efwn|eIo5~w+R3y`2Y9=?KGvcCUaroa%Ev=)!N-B=BZ6G zMVGqh4DPATEJB7~jPW34H|E?c+#stelkKHk;R-Zt6(gIs+%T0vj@=@J9v9S$$ChRV zPpnTVR3B}6Y5D&3y0HGS-6>!Gpn(a&GRu|JB9lj@y#i@gh&YT>LV%`rryIlQ8jo#OuAp?x803 z8-c2^i9Y5>xIG58e6rCQX8Az`^0&!$C8&F+aC|EBDJ<` z`XI8tr5rVR1j$&>|Bg8ybK9{DxpYO;@*I0MM91f}=}2eaW`!PI)C{}_df#A{ukZOW z?vFhb7f)svLWMx>xV3j5$c36a9CMGqm7PlgGw^k$Zyzb-W^Yw8bU95@{EF>{@%rSu zp7f`qVasTeT(dA&Sp(8(Hu5hqi)KeN`P)$Ly6!D%Ozb5AlGmce@o(|X9C8Lq8K4rY zCKs928rgeC6)p>15W}!aGo$6A>;VSmv{tYYCt#Vr(R+77|C5H?*$Yso=*6=I2K*@q z&?>o4$q<7|M1eiL%DhkK1^+i=DQEYAtL#9y<{U9FUu^G8fhUv|<%LivLdru#df9~t zVz)&>8eiwBTf*bPM@novBeKyRV-?ekS9EP>s9V%myF?mzKz=Bza#@!Yu1@Zr(Kx?` zjgMrDhb01I!cHd+OuUYGRbluFr!pmG`su~Y=MW|Z5?`*K(RrIU-dap*8a&#~8J0A^ zwo|$K$Aq1;_iv~lrC`ErH>x78V)brmH!%c14!1}@yGb%wUgM;1uA4*yw2`D*ZArJ; z)WK71|8D9bHzc!J2{WI0*~7#caGC-KI#GEbGFKoaD*W_mKj?dYUlJdRWt1lEP`C zLAe$ox}>2&X)b`1KlGZ8EX|%NQgjJebPS|Cl-@g(w;itCe0LqF9Ruv7xBIkgl6vuX zaMe)bMq3NI*+U8svz7khmRbGRWw5U9q zVq2a?dt78Adi=$#8mG_Xkh1P9Xo!3%!3$~EwAC~OTt$ui#W0*NZ6zr+&XDZ73+mH- zKCZ>Mdy4s{sVqw=Y{jG+F(8gt1qQE_ky-lq)amP`vEj#W!^wT7Rx1=$wYA)^0|f5^ z^7NYGf?iH;pXx5DOF*bXf`W=G@xX|nPg?gPD)uGUCIv*F!8<{8=@)d1DKINqWD;DT z+tAUWhViP_>syWuJ`mZyOz&&kmSyibkY3x|Qt{}^Sc@{??s1G|!)cN=N(aqOIaVdx zlX%*VscVgu;8UgI*0D+Q7_&H%+=ox6%|f5eSmTW+HLQm%5Q6cDU~z&g$1%Qw zZ*ronG|10S7jV@rJ*8Z1hZr$*^HOvU1@>%9PVbDSQ_*H1F zK@;l>G)MczK#)s%I&as)lOkZf6<)kvSP_1OtiAG=411bTt!@Q^;yK`ohk@KYq?$hI zHe@%6v>q;hb)zp9-2I-AMvlH-SXF;QZFF--oTIbOu1)kw?WqM%j>8zg+TbhaV<4zq zRgRkh&X%N)HbEsV9gc$)mVG8i`3W3OX`)MHulV)#ZTu?&&%gdQx3P5$B|5+nv{M~L zxXZzA-O>RwO+^}!CfJ!MW(>Vdq$Oo^VP1DEqNZr>;Q2tU(jz=TK3KE-O>AdJ9#x)J zY>SA1>YivRUs{P*%Cum-SK%9@W>@#I;bG=WFGk7s!#B7rB5Nvz3ga$b+@&`k$*;Aw z_Imm)!jr5m4;-= zp*cFWYYx#Z4y^Ya$4Tnq3AJ8E*YvT{_r^%Z-r6`;T2#-z-1aWWe`6+js6|h`_40hn z3?hQJ%hjEguk2#wRBH)4ds)eu)@7SFgN@@LA49BBXqsK~%JH~Zc8iToI=;m=-ll?; zboK=dzi)}3oU%b$cK;c-b8X|#6UUenqe$={l4krx5yB?JW?jug_sZWJ1Yh15eZJ%W z>Cx*av0D&n$%&`Z`D6AVr2)ev9iT2*!_f~X$F+%}n|v)DKbxs`Y1rW7QHo2%-^ zSqWSV7oHAuHizGOtk?2Ra02%LcJ`EeX~RnFbU=QUaa~|-aAf#dyX<(D?Y1)t!tF6B zZQ1F`Ph1eSMp+R@BP)|;Dg(qY$k=m=`Np4cCj>h06xj(s(^ zqOgcUL~wcP^4jso+9^Df9@fL-MZqIXlcx(gFY`7J96v!%I;fnnS?|L~;20e2rWa99 zvVU;g+|b{l8n>V9nVHa|#Mxsvlwk2Yvrl>ishfk$!tuB+w zXP`59K7DIRX_?>c?*}JN>XKlDd$C1$1a$Duv%HTl9_Tl*3g1z!c$vNUwfaQf%2=j_ z(pD;>@g*1L$TN(4B}dC{S>i`vTg^-_zLxszIy2r1_Ut1>!vo8`l=Z$1nXvwdKR``> zbO={^26L?CVv}y&sl`jVg&wUs0qG10`o`CA)eXQUV}-hf{pM?b7rb7VaQ4g#<@U5o zW#p!I^DVV1j=mE*R=MS|8cU1!Sx`^v9J=qm8JRLe`5qD^7*Fots|cGv^! zTzqJx@0>CvLnnzYalRUa7-qK~M!s--Lj7jZ_2c8qp}~)pa?g_u#RT06ryOG}$xfp> z^ujBg=JVCJQLKUfwZZ33WkYPK52Xf;iR)zSXu4)t;TzYcu2Wq{s!FHZ-hZp5Bd*R@ z*?6{W#V)OvWBv5gD|nPaiU4ai_EY|+Wp*O*_v zyZaza4XnXhK2U~6Q|Ehq^tK*$;omJDq-YGgiU@WPu@7gmz+J;5Vvn^rQP@G*@Y7F1}tyY^s7Crvm>JYU*p_*AB>K8wcv|l1;haIZuDuD_kqU} z&L}^@*T+vvsr$w3#)wf0SoGu?o)DnSu&(N?Y3*_L>S(tZ@4i1jthw$KkWT5t{#>Iv z^oGDa&6KC9+DB#_(ydpN%Us;shH6^p5cNi0Zr<22<_7Wn?Rm#C7mEkRGo7Idr%1c| z{mP@fDL@!gwagv*$x?HPO}mn_s8_fNzT|d!j$AV1dDjG?_LqJ=HLaZ~JP!wMiB6Ev z-yPy>8$)AZ9dBl-LkeGtT$-n7owa#0gecqoLVhd2)2v+ucWi7Za)^|1TG@J7;J#tX zQ+F&(lXvgF@cqK6)L+^QT$xf%U7skCy65zXUqBajyEwTJgm`d!r+SP(!?uV#s$13=#DcX}KIh1Wjj(Jy%ul@A!EI}mGj)tC&}1?UZ1|;$ zBE=x^%&fMUs8tAWoXsxjhY6GSiigNo2vIXiRf(?_SZp|0eUXSNY5B8QNJIR@R}t^i51VJfS{@So<7|$XhH)dlDQ@R1xeAah$ks%8 zNH@g;=6)fq+{#?$8d#+Lj1ukVBhsx#YSk=3`gK!G@2LFL47yL0h8U}NtqE~rk)z(~ zq`^Xhw3l>LpM{mDUU{s`_tCjRVC%HAT3PO>Ra>6*hd8o1(btzBoz}v7Oqmxl0FRQI zp^nv>bZKUbMqfOUxxaqUJ_lR2nyE0GF*g776!M0dYEJZKf0R~&>}@-0eXNOg(8iHT zE~MtO#?{(wP%Y^kUodER7L(g<@Hk>uTLIgzkA8o{>oEbl5fE4M{#lKjQJ3ru=sni zp-s8{SNRqj9*0qXl!=AB?kG9R_PkeLy(k}n&_uk|>{_z}o>-&%Ql18{t3}cs79x;G zl{}(M&>)0yYGG+l*NNrx4t(mAl+Li15o#^HbQatACI!OTsC;-7&hg{ zH83jGY>TKwz2%XTYxGFNWnd3g_tM9T?Y%PyhG--@BHgBP^sO0l3Xlxd3a}DRnX7yR zL|rpF;Fxq@D0bO!G_tC(<13EOK>E;YhMUiegwH$s@fT>}4u7RpEtp+8w|O(ek4a3$ zBBT0sS3nEL0+TxRLbs|Ndhsh&Yf3$t3t)VW&)^Hh_G)4x69w$h*URe`+f5wn?!)8P zH-sl?jo90dt1pX+zEBC5Am2Wp%5g0by>WPQrT;z|0`l}ezT51c7$90*ZNbFOWh&+%NUHwCnvP8qV78d~%0o;?)G5U{u1mm)jx)bcc(S2Z3@Smp^D zwj>^YQ1+EupCq-U_hB7h{5^x$(EI#Mg_q|dF`rvm&ON#P)KN2!cbaoiLFX6h$(E}g zF0l}Mg%<*iY}hp59do91esqV{`R=Pnhe)bian}TYNvxBbt&N*g9q%jEWQ30!DP4e_XN~qMtPqrr+ANqb( zCnQw#s|%!aZBXR;#I#8yPgQuoFgF)kVAOeT*z)|WJ)FUyNiB!K%$#1F4?L2p7*)yP z{X`KK?Z)e(%F*0CEh;)uW0icA_|sa91qO?iW`hMLGu4=v=o?nsUgK_qEx2mE8;;Uh zg>P1A-fy{4e`>cwi~_j=^PGSM=`YJuHg75p)e*#aqeCCuJb!cH%wVwtw zw}6#BS(Vv}ilMxojSY*$p17WhJCBG(QalJ`1yJDmomu6pKrV@v* z33X@7+g^n=_nfpI9@WfH0EL~OK;f!QWXu(^AQ;^*==r1ZU+edBBkLSdY}je`kFpcI zm7%yOw^aE2CTx~niW56+oBi}8FBp!B%lF$1C|BM~q0r^1>}n*jYrz&ewDi9Y z%R51}n1RII;l0Ei(s2H;u3s$VT2zAhB_Ih039SBpEQC*cZTF-U!k=GX^W95>MeF~_ z;Jv-_GsAaUuh@$|T6}RYulG*NlQNgH!{^m*R^quDZuv3YI#ptVE z!bvmi-Gx_Jkq;hq<0YLKij?HRM@fzJ!u5N=>_+W9-@b)|*h-{VJ}L^+ JoTgLM{{qv>T{Qpz literal 0 HcmV?d00001 diff --git a/src/com/github/fxrouter/FXRouter.java b/src/com/github/fxrouter/FXRouter.java new file mode 100644 index 0000000..d3381b7 --- /dev/null +++ b/src/com/github/fxrouter/FXRouter.java @@ -0,0 +1,282 @@ +package com.github.fxrouter; + +/* + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + */ +import java.io.IOException; +import java.util.AbstractMap; +import java.util.HashMap; +import javafx.fxml.FXMLLoader; +import javafx.stage.Stage; +import javafx.scene.Scene; +import javafx.scene.Parent; +import javafx.util.Duration; +import javafx.animation.FadeTransition; + + +/** + * FXRouter allows to manage scenes switching on JavaFX Application with an easy API + * Inspired by Angular JS $routeProvider + * @author Marco Trombino + * @version 0.1.0 + */ +public final class FXRouter { + private static final String WINDOW_TITLE = ""; + private static final Double WINDOW_WIDTH = 800.0; + private static final Double WINDOW_HEIGHT = 600.0; + private static final Double FADE_ANIMATION_DURATION = 800.0; + + // FXRouter Singleton + private static FXRouter router; + // FXRouter Main Class reference to get main package + private static Object mainRef; + // FXRouter Application Stage reference to set scenes + private static Stage window; + + // Application Stage title + private static String windowTitle; + // Application Stage size + private static Double windowWidth; + private static Double windowHeight; + + // routes switching animation + private static String animationType; + private static Double animationDuration; + + // FXRouter routes map + private static AbstractMap routes = new HashMap<>(); + // FXRouter current route + private static RouteScene currentRoute; + + /** + * FXRouter Inner Class used into routes map + */ + private static class RouteScene { + // route .fxml Scene path + private String scenePath; + // Scene (Stage) title + private String windowTitle; + private double sceneWidth; + private double sceneHeight; + // route data passed from goTo() + private Object data; + + private RouteScene(String scenePath) { + this(scenePath, getWindowTitle(), getWindowWidth(), getWindowHeight()); + } + + private RouteScene(String scenePath, String windowTitle) { + this(scenePath, windowTitle, getWindowWidth(), getWindowHeight()); + } + + private RouteScene(String scenePath, double sceneWidth, double sceneHeight) { + this(scenePath, getWindowTitle(), sceneWidth, sceneHeight); + } + + /** Route scene constructor + * @param scenePath: .FXML scene file + * @param windowTitle: Scene (Stage) title + * @param sceneWidth: Scene Width + * @param sceneHeight: Scene Height + */ + private RouteScene(String scenePath, String windowTitle, double sceneWidth, double sceneHeight) { + this.scenePath = scenePath; + this.windowTitle = windowTitle; + this.sceneWidth = sceneWidth; + this.sceneHeight = sceneHeight; + } + + private static String getWindowTitle() { + return FXRouter.windowTitle != null ? FXRouter.windowTitle : WINDOW_TITLE; + } + + private static double getWindowWidth() { + return FXRouter.windowWidth != null ? FXRouter.windowWidth : WINDOW_WIDTH; + } + + private static double getWindowHeight() { + return FXRouter.windowHeight != null ? FXRouter.windowHeight : WINDOW_HEIGHT; + } + } + + /** + * FXRouter constructor kept private to apply Singleton pattern + */ + private FXRouter() {} + + public static void bind(Object ref, Stage win) { + checkInstances(ref, win); + } + + public static void bind(Object ref, Stage win, String winTitle) { + checkInstances(ref, win); + windowTitle = winTitle; + } + + public static void bind(Object ref, Stage win, double winWidth, double winHeight) { + checkInstances(ref, win); + windowWidth = winWidth; + windowHeight = winHeight; + } + + /** FXRouter binder with Application Stage and main package + * @param ref: Main Class reference + * @param win: Application Stage + * @param winTitle: Application Stage title + * @param winWidth: Application Stage width + * @param winHeight: Application Stage height + */ + public static void bind(Object ref, Stage win, String winTitle, double winWidth, double winHeight) { + checkInstances(ref, win); + windowTitle = winTitle; + windowWidth = winWidth; + windowHeight = winHeight; + } + + /** set FXRouter references only if they are not set yet + * @param ref: Main Class reference + * @param win: Application Stage + */ + private static void checkInstances(Object ref, Stage win) { + if(mainRef == null) + mainRef = ref; + if(router == null) + router = new FXRouter(); + if(window == null) + window = win; + } + + public static void when(String routeLabel, String scenePath) { + RouteScene routeScene = new RouteScene(scenePath); + routes.put(routeLabel, routeScene); + } + + public static void when(String routeLabel, String scenePath, String winTitle) { + RouteScene routeScene = new RouteScene(scenePath, winTitle); + routes.put(routeLabel, routeScene); + } + + public static void when(String routeLabel, String scenePath, double sceneWidth, double sceneHeight) { + RouteScene routeScene = new RouteScene(scenePath, sceneWidth, sceneHeight); + routes.put(routeLabel, routeScene); + } + + /** Define a FXRouter route + * @param routeLabel: Route label identifier + * @param scenePath: .FXML scene file + * @param winTitle: Scene (Stage) title + * @param sceneWidth: Scene Width + * @param sceneHeight: Scene Height + */ + public static void when(String routeLabel, String scenePath, String winTitle, double sceneWidth, double sceneHeight) { + RouteScene routeScene = new RouteScene(scenePath, winTitle, sceneWidth, sceneHeight); + routes.put(routeLabel, routeScene); + } + + public static void goTo(String routeLabel) throws IOException { + // get corresponding route + RouteScene route = routes.get(routeLabel); + loadNewRoute(route); + } + + /** Switch between FXRouter route and show corresponding scenes + * @param routeLabel: Route label identifier + * @param data: Data passed to route + * @throws Exception: throw FXMLLoader exception if file is not loaded correctly + */ + public static void goTo(String routeLabel, Object data) throws IOException { + // get corresponding route + RouteScene route = routes.get(routeLabel); + // set route data + route.data = data; + loadNewRoute(route); + } + + /** Helper method of goTo() which load and show new scene + * @throws Exception: throw FXMLLoader exception if file is not loaded correctly + */ + private static void loadNewRoute(RouteScene route) throws IOException { + // get Main Class package name to get correct files path + String pathRef = mainRef.getClass().getPackageName(); + + // set FXRouter current route reference + currentRoute = route; + + // create correct file path. "/" doesn't affect any OS + String scenePath = "/" + pathRef + "/" + route.scenePath; + + // load .fxml resource + Parent resource = FXMLLoader.load(new Object() { }.getClass().getResource(scenePath)); + + // set window title from route settings or default setting + window.setTitle(route.windowTitle); + // set new route scene + window.setScene(new Scene(resource, route.sceneWidth, route.sceneHeight)); + // show the window + window.show(); + + // set scene animation + routeAnimation(resource); + } + + /* Syntactic sugar for goTo() method when FXRouter get set */ + public static void startFrom(String routeLabel) throws Exception { + goTo(routeLabel); + } + + public static void startFrom(String routeLabel, Object data) throws Exception { + goTo(routeLabel, data); + } + + /** set FXRouter switching animation + * @param anType: Animation type + */ + public static void setAnimationType(String anType) { + animationType = anType; + } + + /** set FXRouter switching animation + * @param anType: Animation type + * @param anDuration: Animation duration + */ + public static void setAnimationType(String anType, double anDuration) { + animationType = anType; + animationDuration = anDuration; + } + + /** Animate routes switching based on animation type + * @param resource: .FXML scene file to animate + */ + private static void routeAnimation(Parent node) { + String anType = animationType != null ? animationType.toLowerCase() : ""; + switch(anType) { + case "fade": + Double fd = animationDuration != null ? animationDuration : FADE_ANIMATION_DURATION; + FadeTransition ftCurrent = new FadeTransition(Duration.millis(fd), node); + ftCurrent.setFromValue(0.0); + ftCurrent.setToValue(1.0); + ftCurrent.play(); + break; + default: + break; + } + } + + /** Get current route data + */ + public static Object getData() { + return currentRoute.data; + } + +} \ No newline at end of file