Codebase Structure

Added by Abhijit Borude, last edited by Ben Peters on Nov 21, 2008  (view change)

Introduction

Fluency codebase is big and it could be overwhelming to start understanding a small subpart of the codebase by looking at code. E.g. if you were to add your own widget or property, where would you start? This documentation effort should help you get started. It breaks down fluency code in to small pieces which could help beginners.

Outline

  1. Code design (this should explain basic layout of the code..may be based on packages)
  2. Fluency Core
    1. Widgets
      1. How to add new widget?
      2. Widget Registration
      3. WidgetID
      4. WidgetData
      5. Widget Loading
    2. Ships
    3. Docks
    4. Harbors
    5. Shipping Lanes
    6. Pipes
    7. Paths
    8. Clock
    9. Molecules
    10. Fluency Engine
    11. Fluency Loader
    12. Molecule Loader
  3. Fluency Editor
    1. Main editor frame
    2. FluencyModel
    3. Widget finder
    4. Properties frame
    5. Link/Path manager
    6. Toolbar
    7. Clipboard
    8. UsefulMenu
  4. Plugins
  5. Event Handling
    1. [SP2008:GlobalGlassPane]
    2. GlobalListeners
    3. RightClick Menu
    4. Focus Management
  6. Other
    1. Commands:
      1. ModelCommand
      2. AddCommand
      3. CopyCommand
      4. CutCommand
      5. PasteCommand
      6. DeleteCommand
      7. ChangePreferenceCommand
      8. NullModelCommand
    2. Preferences
    3. Fluency Properties
    4. Widget Tags
    5. XML output
    6. Error Infrastructure
    7. Logging
  7. Website
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (1)

 

  1. Nov 12, 2007

    Abhijit Borude says:

    Everybody, please feel free to edit this, add your stuff, link your wiki pages

    Everybody, please feel free to edit this, add your stuff, link your wiki pages