limelight 0.2.0-java → 0.2.1-java

data/bin/limelight

@@ -1,6 +1,5 @@
 #!/usr/bin/env jruby
 require File.expand_path(File.dirname(__FILE__) + "/../lib/init")
-require 'limelight/commands'
-
-Limelight::Commands.run(ARGV)
+require 'limelight/main'
 
+Limelight::Main.run(ARGV)

data/lib/limelight/animation.rb

@@ -1,20 +1,40 @@
 #- Copyright 2008 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
-class Animation < Limelight::AnimationTask
+module Limelight
 
-  def initialize(prop, block, options={})
-    @block = block
-    name = options[:name] || "#{prop.to_s} animation"
-    updates_per_second = options[:updates_per_second] || 60
-    super(name, updates_per_second, prop.panel)
-  end
+  # An object to manage a seqeunce of changes, assuably to a prop.  The Animation object is constructed with options
+  # and a block.  Once the Animation is started, the block is invoked repeatedly until the Animation is stopped.
+  #
+  # Although, this object does not update the screen, it provides a means to perform sequential updates in evenly
+  # spaced time frames.
+  #
+  class Animation < Limelight::AnimationTask
+
+    # A Prop and block are required to construct an Animation.  Options may include :name (string), :updates_per_second
+    # (int defaults to 60)
+    #
+    #   animation = Animation.new(prop, Proc.new { "do something"}, :updates_per_second => 20)
+    #   animation.start
+    #   # time passes
+    #   animation.stop
+    #
+    def initialize(prop, block, options={})
+      @block = block
+      name = options[:name] || "#{prop.to_s} animation"
+      updates_per_second = options[:updates_per_second] || 60
+      super(name, updates_per_second, prop.panel)
+    end
 
-  def doPerform
-    @block.call 
-  end        
+    def doPerform #:nodoc:
+      @block.call
+    end
 
-  def running?
-    return is_running
+    # Lets you know if the animation is currently running or not.
+    #
+    def running?
+      return is_running
+    end
   end
+
 end

data/lib/limelight/build_exception.rb

@@ -2,6 +2,9 @@
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight
+
+  # An Exception used by many of the DSL Builders.  Allows nice errors messages, with line numbers, to be printed.
+  #
   class BuildException < Exception
 
     attr_reader :filename, :line_number

data/lib/limelight/builtin/players/button.rb

@@ -5,17 +5,32 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native button.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_button :players => "button"
+      #
+      # Props including this Player should implement the button_pressed hook.
+      #
+      #   def button_pressed(e)
+      #     # do something
+      #   end
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module Button
         class << self
 
-          def extended(prop)
+          def extended(prop) #:nodoc:
             button = Limelight::UI::Model::Inputs::ButtonPanel.new
             prop.panel.add(button)
             prop.button = button.button
           end
         end
 
-        attr_accessor :button
+        attr_accessor :button #:nodoc:
 
       end
 

data/lib/limelight/builtin/players/check_box.rb

@@ -5,21 +5,40 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native check box.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_check_box :players => "check_box"
+      #
+      # Props including this Player may implement the button_pressed hook.
+      #
+      #   def button_pressed(e)
+      #     # do something
+      #   end
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module CheckBox
         class << self
-          def extended(prop)
+          def extended(prop) #:nodoc:
             check_box = Limelight::UI::Model::Inputs::CheckBoxPanel.new
             prop.panel.add(check_box)
             prop.check_box = check_box.check_box
           end
         end
 
-        attr_accessor :check_box
+        attr_accessor :check_box #:nodoc:
 
+        # Will place or remove a check mark in the check box.
+        #
         def checked=(value)
           check_box.selected = value
         end
 
+        # Returns true if the check box is checked.
+        #
         def checked
           return check_box.selected?
         end

data/lib/limelight/builtin/players/combo_box.rb

@@ -5,17 +5,41 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native combo box.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_button :players => "combo_box"
+      #
+      # Props including this Player must not override the mouse_pressed event.
+      #
+      # Props including this Player may implement an additional hook:
+      #
+      #   def value_changed(e)
+      #     # do something
+      #   end
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module ComboBox
+
         class << self
-          def extended(prop)
+          def extended(prop) #:nodoc:
             combo_box = Limelight::UI::Model::Inputs::ComboBoxPanel.new
             prop.panel.add(combo_box)
             prop.combo_box = combo_box.combo_box
           end
         end
 
-        attr_accessor :combo_box
+        attr_accessor :combo_box #:nodoc:
 
+        # Sets the choices listed in the combo_box.  The value parameter should an Array or a String that
+        # can be evalulated into an Array.  All choices in a combo_box are strings.
+        #
+        # combo_box.choices = ["one", "two", "three"]
+        # combo_box.choices = "['one', 'two', 'three']"
+        #
         def choices=(value)
           value = eval(value) if value.is_a? String
           raise "Invalid choices type: #{value.class}.  Choices have to be an array." if !value.is_a?(Array)
@@ -24,15 +48,19 @@ module Limelight
           value.each { |choice| combo_box.add_item(choice) }
         end
 
+        # Sets the value of the combo box. The value provided should be one choices in the combo box.
+        #
         def value=(text)
           self.text = text
         end
 
+        # Returns the value of the currently selected choice.
+        #
         def value
           return self.text
         end
 
-        def mouse_pressed(e)
+        def mouse_pressed(e) #:nodoc:
           curtains = Limelight::Prop.new(:name => "limelight_builtin_players_curtains", :players => "curtains")
 
           popup_list = Limelight::Prop.new(:name => "limelight_builtin_players_combo_box_popup_list", :players => "combo_box_popup_list", :curtains => curtains)

data/lib/limelight/builtin/players/combo_box_popup_list.rb

@@ -5,7 +5,7 @@ module Limelight
   module Builtin
     module Players
 
-      module ComboBoxPopupList
+      module ComboBoxPopupList #:nodoc:
 
         attr_accessor :curtains
 

data/lib/limelight/builtin/players/combo_box_popup_list_item.rb

@@ -5,7 +5,7 @@ module Limelight
   module Builtin
     module Players
 
-      module ComboBoxPopupListItem
+      module ComboBoxPopupListItem #:nodoc:
 
         attr_accessor :combo_box
 

data/lib/limelight/builtin/players/curtains.rb

@@ -5,7 +5,7 @@ module Limelight
   module Builtin
     module Players
 
-      module Curtains
+      module Curtains #:nodoc:
 
         def open
           scene.remove(self)

data/lib/limelight/builtin/players/radio_button.rb

@@ -5,28 +5,52 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native radio button.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_radio_button :players => "radio_button", :id => "radio1", :group => "my_radio_button_group"
+      #
+      # When including this Player, it's important to specify a group and id.  All radio buttons in the same group will
+      # be mutually exclusive.  The value of a radio button group will be the id of the selected radio button.
+      #
+      # Props including this Player may implement the button_pressed hook.
+      #
+      #   def button_pressed(e)
+      #     # do something
+      #   end
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module RadioButton
         class << self
-          def extended(prop)
+          def extended(prop) #:nodoc:
             radio_button = Limelight::UI::Model::Inputs::RadioButtonPanel.new
             prop.panel.add(radio_button)
             prop.radio_button = radio_button.radio_button
           end
         end
 
-        attr_accessor :radio_button
-        attr_reader :button_group
+        attr_accessor :radio_button #:nodoc:
+        attr_reader :button_group #:nodoc:
 
+        # Sets the radio button group to which this radio button belongs.
+        #
         def group=(group_name)
           @button_group = scene.button_groups[group_name]
           @button_group.add(@radio_button)
         end
 
+        # Checks or unchecks this radio button.
+        #
         def checked=(value)
           @radio_button.selected = value
         end
         alias :selected= :checked=
 
+        # Returns true is this radio is button is checked.
+        #
         def checked
           return @radio_button.is_selected
         end

data/lib/limelight/builtin/players/text_area.rb

@@ -5,10 +5,19 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native text area.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_text_area :players => "text_area"
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module TextArea
         class << self
 
-          def extended(prop)
+          def extended(prop) #:nodoc:
             text_area = Limelight::UI::Model::Inputs::TextAreaPanel.new
             prop.panel.add(text_area)
             prop.text_area = text_area.text_area
@@ -16,7 +25,7 @@ module Limelight
 
         end
 
-        attr_accessor :text_area
+        attr_accessor :text_area #:nodoc:
 
       end
 

data/lib/limelight/builtin/players/text_box.rb

@@ -5,10 +5,19 @@ module Limelight
   module Builtin
     module Players
 
+      # A Builtin Player that adds the look and behavior of a native text box.  It may be applied in the PropBuilder DSL
+      # like so:
+      #
+      #   my_text_box :players => "text_box"
+      #
+      # Props including this Player may implement any of the key and focus event hooks:
+      #
+      #   key_pressed, key_typed, key_released, focus_gained, focus_lost
+      #
       module TextBox
         class << self
 
-          def extended(prop)
+          def extended(prop) #:nodoc:
             text_box = Limelight::UI::Model::Inputs::TextBoxPanel.new
             prop.panel.add(text_box)
             prop.text_box = text_box.text_box
@@ -16,7 +25,7 @@ module Limelight
 
         end
 
-        attr_accessor :text_box
+        attr_accessor :text_box #:nodoc:
 
       end
 

data/lib/limelight/button_group_cache.rb

@@ -2,8 +2,8 @@
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
 module Limelight
-  ButtonGroupCache = UI::ButtonGroupCache
-  class ButtonGroupCache
+  ButtonGroupCache = UI::ButtonGroupCache #:nodoc:
+  class ButtonGroupCache #:nodoc:
     def [](key)
       return self.get(key)
     end

data/lib/limelight/casting_director.rb

@@ -4,7 +4,12 @@
 require 'limelight/builtin/players'
 
 module Limelight
-  
+
+  # The CastingDirector is responsible for finding Players for Props within a Production.
+  # Each Producer has an instance of a CastingDirector
+  #
+  # Users of Limelight need not be concerned with this class.
+  #
   class CastingDirector
     
     def initialize(loader)

data/lib/limelight/commands.rb

@@ -1,14 +1,18 @@
 #- Copyright 2008 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
-require 'optparse'
-
 module Limelight
 
   DEFAULT_PRODUCTION = File.expand_path(File.dirname(__FILE__) + "/../../productions/startup")
 
+  # Commands used in the Main method.
+  #
   module Commands
 
+    # Opens a Production
+    #
+    #   jruby -S limelight open <production_name>
+    #
     class OpenProduction
       def self.description
         return "Open a limelight production or scene."
@@ -22,6 +26,10 @@ module Limelight
       end
     end
 
+    # Compresses the specified Production into a single .llp file.
+    #
+    #   jruby -S limelight pack <production_name>
+    #
     class PackProduction
       def self.description
         return "Pack the designated limelight production into a .llp file."
@@ -38,28 +46,6 @@ module Limelight
         "pack" => PackProduction
     }
 
-    class << self
-      def run(args)
-        command_name = args.shift
-        command = COMMANDS[command_name]
-        if command
-          command.new.run(args)
-        else
-          usage
-        end
-      end
-
-      def usage
-        puts "Usage: limelight <command> [options] [params]"
-        puts "commands:"
-        COMMANDS.keys.sort.each do |key|
-          command = COMMANDS[key]
-          puts "\t#{key}\t\t#{command.description}"
-        end
-      end
-    end
-
-
   end