Fluency Package Breakdown

Ok, so this is a long-time coming: a full breakdown of the Fluency packages. Here is a quick description of what is where for people looking to increase their familiarity with it. Note that you can click on any of the package names and go to a page with a (slightly) more thorough description of that package.
Two general notes:

  1. None of the 4 superpackages (editor, engine, shared, and media) have any files in them with the exception of media. This single .java file in media exists as an unfortunately necessity when working with resources outside of the desktop environment.
  2. All Null versions of classes are located in the same package as that class. The exceptions to this are the Null classes needed for Java library classes (which do not have any Null versions); these classes have their own package in the shared superpackage.

Package Structure:

  • org.knownspace.fluency : The main package name for this project
    • editor : Packages for code that pertains specifically to the Editor and nothing else.
      • events : All custom events used by the Editor.
      • GUI : Packages for the Graphical User Interface of the Editor.
        • core : Core files needed for the GUI to run.
        • iconography : Files used for supporting iconography.
        • types : Files for basic types used by the GUI.
        • widgetfinder : Files just for the widget tag navigator.
      • loaders : Files for all of the different loader classes that the Editor uses.
      • models : Packages for models for Editor and individual apps. Also all commands for those models.
        • application : Files for model and commands for the application models.
        • editor : Files for model and commands for the Editor model.
        • helpers : Files that work only with the models and commands but are not models or commands.
      • plugins : Packages for default plugin files and files need to support plugins.
        • defaultplugin : Files for default view plugin.
        • engine : Files for engine entry-point plugin (default engine).
        • gesture : Files for gesture plugin.
        • identifiers : Identification files used by plugins.
        • listboxlinkage : Files for listbox view plugin.
        • molecule : Files for Molecule widget editor plugin.
        • propertyeditor : Files for property explorer plugin.
        • types : Files for basic types used by plugins.
      • preferences : Files for maintaining a set of persistent preferences in the Editor.
      • tags : Files used by the tagging system in the Editor.
    • engine : Packages for code that pertain specifically to the Engine and nothing else.
      • clocks : Files needed by the clock that the Engine uses.
      • core: Base files that the Engine needs to run.
      • dock : Files for docks.
      • exceptions : Files for exceptions used internally by the Engine.
      • harbor : Files for harbors.
      • layout : Files used by the Engine to control widget layout.
      • ship : Files for ships.
    • media : Packages for all non-code files used by the project. Contains reference file for loading resource files.
      • examples : Fluency save files showing example programs.
      • images : Packages for all image files that are used by the Editor.
        • iconography : Images used for icons.
        • misc : Misc. images used by the editor
        • widget : Images used to support displaying the builtin widgets.
    • shared : Packages for code that both the Engine AND the Editor need to use.
      • identifiers : Files for identifying different objects.
      • nullobjects : Files for any Null objects that apply to external library classes.
      • prototypes : Files needed to make prototypes of Widgets for use by the Editor.
      • types : Files for basic types used by misc. other classes.
      • util : Files for utility classes that are used to centralize commonly used functionality.
      • widget : Packages for builtin widget classes and supporting classes.
        • categories : Packages for all builtin widget classes.
          • converters : Files for special widgets used in autoconversion of ships.
          • nonvisual : Files for all nonvisual widgets.
          • visual : Files for all visual widgets.
        • core : Files for basic widget functionality.
        • property : Files for widget properties.
          • view : View classes for the visual representations of properties.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.