limelight 0.2.0-java → 0.2.1-java

data/lib/limelight/styles.rb

@@ -1,37 +1,334 @@
 #- Copyright 2008 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
 
-require 'yaml'
-
 module Limelight
-  
-  class Styles
-
-    def self.load(content)
-      yamalized_content = content.gsub("\t", "  ").gsub("#", "pigpen")
-      return YAML.load(yamalized_content)
-    end
-
-    def self.load_into_scene(filename, scene)
-      content = scene.loader.load(filename)
-      style_defs = load(content)
-      styles = scene.styles;
-  
-      style_defs.each_pair do |key, value|
-        style = create_style(value)
-        styles[key] = style
-      end
-    end
-
-    def self.create_style(hash)
-      style = Styles::FlatStyle.new
-      hash.each_pair do |key, value|
-        value = value.to_s.gsub("pigpen", "#")
-        style.send((key.to_s + "=").to_sym, value)
-      end
-      return style
-    end
 
+  # This module is for reference only.  The Style class is a java class for various reasons.
+  #
+  module Styles
+    # Specifies the Width of a prop.
+    #
+    #   style.width = <value>
+    #
+    Width  = Limelight::Styles::Style::STYLE_LIST.get(0)
+
+    # Specifies the Height of a prop.
+    #
+    #   style.height = <value>
+    #
+    Height  = Limelight::Styles::Style::STYLE_LIST.get(1)
+
+    # Specifies the Min Width of a prop.
+    #
+    #   style.min_width = <value>
+    #
+    MinWidth  = Limelight::Styles::Style::STYLE_LIST.get(2)
+
+    # Specifies the Min Height of a prop.
+    #
+    #   style.min_height = <value>
+    #
+    MinHeight  = Limelight::Styles::Style::STYLE_LIST.get(3)
+
+    # Specifies the Max Width of a prop.
+    #
+    #   style.max_width = <value>
+    #
+    MaxWidth  = Limelight::Styles::Style::STYLE_LIST.get(4)
+
+    # Specifies the Max Height of a prop.
+    #
+    #   style.max_height = <value>
+    #
+    MaxHeight  = Limelight::Styles::Style::STYLE_LIST.get(5)
+
+    # Specifies the Vertical Scrollbar of a prop.
+    #
+    #   style.vertical_scrollbar = <value>
+    #
+    VerticalScrollbar  = Limelight::Styles::Style::STYLE_LIST.get(6)
+
+    # Specifies the Horizontal Scrollbar of a prop.
+    #
+    #   style.horizontal_scrollbar = <value>
+    #
+    HorizontalScrollbar  = Limelight::Styles::Style::STYLE_LIST.get(7)
+
+    # Specifies the Top Border Color of a prop.
+    #
+    #   style.top_border_color = <value>
+    #
+    TopBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(8)
+
+    # Specifies the Right Border Color of a prop.
+    #
+    #   style.right_border_color = <value>
+    #
+    RightBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(9)
+
+    # Specifies the Bottom Border Color of a prop.
+    #
+    #   style.bottom_border_color = <value>
+    #
+    BottomBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(10)
+
+    # Specifies the Left Border Color of a prop.
+    #
+    #   style.left_border_color = <value>
+    #
+    LeftBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(11)
+
+    # Specifies the Top Border Width of a prop.
+    #
+    #   style.top_border_width = <value>
+    #
+    TopBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(12)
+
+    # Specifies the Right Border Width of a prop.
+    #
+    #   style.right_border_width = <value>
+    #
+    RightBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(13)
+
+    # Specifies the Bottom Border Width of a prop.
+    #
+    #   style.bottom_border_width = <value>
+    #
+    BottomBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(14)
+
+    # Specifies the Left Border Width of a prop.
+    #
+    #   style.left_border_width = <value>
+    #
+    LeftBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(15)
+
+    # Specifies the Top Margin of a prop.
+    #
+    #   style.top_margin = <value>
+    #
+    TopMargin  = Limelight::Styles::Style::STYLE_LIST.get(16)
+
+    # Specifies the Right Margin of a prop.
+    #
+    #   style.right_margin = <value>
+    #
+    RightMargin  = Limelight::Styles::Style::STYLE_LIST.get(17)
+
+    # Specifies the Bottom Margin of a prop.
+    #
+    #   style.bottom_margin = <value>
+    #
+    BottomMargin  = Limelight::Styles::Style::STYLE_LIST.get(18)
+
+    # Specifies the Left Margin of a prop.
+    #
+    #   style.left_margin = <value>
+    #
+    LeftMargin  = Limelight::Styles::Style::STYLE_LIST.get(19)
+
+    # Specifies the Top Padding of a prop.
+    #
+    #   style.top_padding = <value>
+    #
+    TopPadding  = Limelight::Styles::Style::STYLE_LIST.get(20)
+
+    # Specifies the Right Padding of a prop.
+    #
+    #   style.right_padding = <value>
+    #
+    RightPadding  = Limelight::Styles::Style::STYLE_LIST.get(21)
+
+    # Specifies the Bottom Padding of a prop.
+    #
+    #   style.bottom_padding = <value>
+    #
+    BottomPadding  = Limelight::Styles::Style::STYLE_LIST.get(22)
+
+    # Specifies the Left Padding of a prop.
+    #
+    #   style.left_padding = <value>
+    #
+    LeftPadding  = Limelight::Styles::Style::STYLE_LIST.get(23)
+
+    # Specifies the Background Color of a prop.
+    #
+    #   style.background_color = <value>
+    #
+    BackgroundColor  = Limelight::Styles::Style::STYLE_LIST.get(24)
+
+    # Specifies the Secondary Background Color of a prop.
+    #
+    #   style.secondary_background_color = <value>
+    #
+    SecondaryBackgroundColor  = Limelight::Styles::Style::STYLE_LIST.get(25)
+
+    # Specifies the Background Image of a prop.
+    #
+    #   style.background_image = <value>
+    #
+    BackgroundImage  = Limelight::Styles::Style::STYLE_LIST.get(26)
+
+    # Specifies the Background Image Fill Strategy of a prop.
+    #
+    #   style.background_image_fill_strategy = <value>
+    #
+    BackgroundImageFillStrategy  = Limelight::Styles::Style::STYLE_LIST.get(27)
+
+    # Specifies the Gradient of a prop.
+    #
+    #   style.gradient = <value>
+    #
+    Gradient  = Limelight::Styles::Style::STYLE_LIST.get(28)
+
+    # Specifies the Gradient Angle of a prop.
+    #
+    #   style.gradient_angle = <value>
+    #
+    GradientAngle  = Limelight::Styles::Style::STYLE_LIST.get(29)
+
+    # Specifies the Gradient Penetration of a prop.
+    #
+    #   style.gradient_penetration = <value>
+    #
+    GradientPenetration  = Limelight::Styles::Style::STYLE_LIST.get(30)
+
+    # Specifies the Cyclic Gradient of a prop.
+    #
+    #   style.cyclic_gradient = <value>
+    #
+    CyclicGradient  = Limelight::Styles::Style::STYLE_LIST.get(31)
+
+    # Specifies the Horizontal Alignment of a prop.
+    #
+    #   style.horizontal_alignment = <value>
+    #
+    HorizontalAlignment  = Limelight::Styles::Style::STYLE_LIST.get(32)
+
+    # Specifies the Vertical Alignment of a prop.
+    #
+    #   style.vertical_alignment = <value>
+    #
+    VerticalAlignment  = Limelight::Styles::Style::STYLE_LIST.get(33)
+
+    # Specifies the Text Color of a prop.
+    #
+    #   style.text_color = <value>
+    #
+    TextColor  = Limelight::Styles::Style::STYLE_LIST.get(34)
+
+    # Specifies the Font Face of a prop.
+    #
+    #   style.font_face = <value>
+    #
+    FontFace  = Limelight::Styles::Style::STYLE_LIST.get(35)
+
+    # Specifies the Font Size of a prop.
+    #
+    #   style.font_size = <value>
+    #
+    FontSize  = Limelight::Styles::Style::STYLE_LIST.get(36)
+
+    # Specifies the Font Style of a prop.
+    #
+    #   style.font_style = <value>
+    #
+    FontStyle  = Limelight::Styles::Style::STYLE_LIST.get(37)
+
+    # Specifies the Transparency of a prop.
+    #
+    #   style.transparency = <value>
+    #
+    Transparency  = Limelight::Styles::Style::STYLE_LIST.get(38)
+
+    # Specifies the Top Right Rounded Corner Radius of a prop.
+    #
+    #   style.top_right_rounded_corner_radius = <value>
+    #
+    TopRightRoundedCornerRadius  = Limelight::Styles::Style::STYLE_LIST.get(39)
+
+    # Specifies the Bottom Right Rounded Corner Radius of a prop.
+    #
+    #   style.bottom_right_rounded_corner_radius = <value>
+    #
+    BottomRightRoundedCornerRadius  = Limelight::Styles::Style::STYLE_LIST.get(40)
+
+    # Specifies the Bottom Left Rounded Corner Radius of a prop.
+    #
+    #   style.bottom_left_rounded_corner_radius = <value>
+    #
+    BottomLeftRoundedCornerRadius  = Limelight::Styles::Style::STYLE_LIST.get(41)
+
+    # Specifies the Top Left Rounded Corner Radius of a prop.
+    #
+    #   style.top_left_rounded_corner_radius = <value>
+    #
+    TopLeftRoundedCornerRadius  = Limelight::Styles::Style::STYLE_LIST.get(42)
+
+    # Specifies the Top Right Border Width of a prop.
+    #
+    #   style.top_right_border_width = <value>
+    #
+    TopRightBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(43)
+
+    # Specifies the Bottom Right Border Width of a prop.
+    #
+    #   style.bottom_right_border_width = <value>
+    #
+    BottomRightBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(44)
+
+    # Specifies the Bottom Left Border Width of a prop.
+    #
+    #   style.bottom_left_border_width = <value>
+    #
+    BottomLeftBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(45)
+
+    # Specifies the Top Left Border Width of a prop.
+    #
+    #   style.top_left_border_width = <value>
+    #
+    TopLeftBorderWidth  = Limelight::Styles::Style::STYLE_LIST.get(46)
+
+    # Specifies the Top Right Border Color of a prop.
+    #
+    #   style.top_right_border_color = <value>
+    #
+    TopRightBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(47)
+
+    # Specifies the Bottom Right Border Color of a prop.
+    #
+    #   style.bottom_right_border_color = <value>
+    #
+    BottomRightBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(48)
+
+    # Specifies the Bottom Left Border Color of a prop.
+    #
+    #   style.bottom_left_border_color = <value>
+    #
+    BottomLeftBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(49)
+
+    # Specifies the Top Left Border Color of a prop.
+    #
+    #   style.top_left_border_color = <value>
+    #
+    TopLeftBorderColor  = Limelight::Styles::Style::STYLE_LIST.get(50)
+
+    # Specifies the Float of a prop.
+    #
+    #   style.float = <value>
+    #
+    Float  = Limelight::Styles::Style::STYLE_LIST.get(51)
+
+    # Specifies the X of a prop.
+    #
+    #   style.x = <value>
+    #
+    X  = Limelight::Styles::Style::STYLE_LIST.get(52)
+
+    # Specifies the Y of a prop.
+    #
+    #   style.y = <value>
+    #
+    Y  = Limelight::Styles::Style::STYLE_LIST.get(53)
   end
-  
+
 end

data/lib/limelight/styles_builder.rb

@@ -1,60 +1,130 @@
 #- Copyright 2008 8th Light, Inc. All Rights Reserved.
 #- Limelight and all included source files are distributed under terms of the GNU LGPL.
+require 'limelight/util'
 
 module Limelight
-  
+
+  # A trigger to define Style objects using the StyleBuilder DSL.
+  #
+  # See Limelight::Stylesbuilder, Limelight::Stylebuilder
+  #
   def self.build_styles(style_hash = nil, &block)
     builder = StylesBuilder.new(style_hash)
     builder.instance_eval(&block) if block
-    return builder.__styles
+    return builder.__styles__
   end
-  
+
+  # The basis of the DSL for building Style objects.
+  #
+  # Sample StyleBuilder DSL
+  #
+  #  sandbox {
+  #    width "100%"
+  #    height "100%"
+  #    vertical_alignment :top
+  #  }
+  #
+  #  sample {
+  #    width 320
+  #    height 320
+  #    gradient :on
+  #  }
+  #
+  #  spinner {
+  #    extends :sample
+  #    background_color :green
+  #    secondary_background_color :blue
+  #    gradient_angle 0
+  #    gradient_penetration 100
+  #  }
+  #
+  # This exmple builds three styles: sandbox, sample, spinner.  Within each style block, the individual attributes of
+  # the style may be set.
+  #
+  # See Limelight::Styles
+  #
   class StylesBuilder
-    attr_reader :__styles
+
+    Limelight::Util.lobotomize(self)
+    
+    attr_reader :__styles__
     
     def initialize(style_hash = nil)
-      @__styles = style_hash || {}
+      @__styles__ = style_hash || {}
     end
     
-    def method_missing(sym, &block)
-      __add_style(sym.to_s, &block)
+    def method_missing(sym, &block) #:nodoc:
+      __add_style__(sym.to_s, &block)
     end
     
-    def __add_style(name, &block)
+    def __add_style__(name, &block) #:nodoc:
       builder = StyleBuilder.new(name, self)
       builder.instance_eval(&block) if block
-      @__styles[name] = builder.__style
+      @__styles__[name] = builder.__style__
     end
   end
-  
+
+  # The basis of the DSL for defining a Style object.
+  #
   class StyleBuilder
-    attr_reader :__style
+
+    Limelight::Util.lobotomize(self)
+
+    attr_reader :__style__  #:nodoc:
     
-    def initialize(name, styles_builder, options = {})
+    def initialize(name, styles_builder, options = {})  #:nodoc:
       @__name = name
       @__styles_builder = styles_builder
-      @__style = @__styles_builder.__styles[name] || Styles::RichStyle.new
+      @__style__ = @__styles_builder.__styles__[name] || Styles::RichStyle.new
     end
-    
+
+    # Used to define a hover style.  Hover styles are appiled when the mouse passed over a prop using the specified style.
+    #
+    #   spinner {
+    #     width 50
+    #     height 50
+    #     hover {
+    #       text_color :white    
+    #     }
+    #   }
+    #
+    # The text color of props using the 'spinner' style will become white when the mouse hovers over them.
+    #
     def hover(&block)
-      @__styles_builder.__add_style("#{@__name}.hover", &block)
+      @__styles_builder.__add_style__("#{@__name}.hover", &block)
     end
 
+    # Styles may extend other styles.
+    #
+    #    base {
+    #      background_color :red
+    #    }
+    #
+    #    cell {
+    #      extends :base
+    #      text_color :black
+    #    }
+    #
+    # The 'cell' style now has all attributes defined in 'base'.  Therefore any prop using the 'cell' style
+    # will have a red background.  Styles may override attributes aquired through extension.
+    #
     def extends(*style_names)
       style_names.each do |style_name|
-        extension = @__styles_builder.__styles[style_name.to_s]
+        extension = @__styles_builder.__styles__[style_name.to_s]
         raise StyleBuilderException.new("Can't extend missing style: '#{style_name}'") if extension.nil?
-        @__style.add_extension(extension)
+        @__style__.add_extension(extension)
       end
     end
                                                                                   
-    def method_missing(sym, value)
+    def method_missing(sym, value) #:nodoc:
       setter_sym = "#{sym}=".to_s
-      raise StyleBuilderException.new("'#{sym}' is not a valid style") if !@__style.respond_to?(setter_sym)
-      @__style.send(setter_sym, value.to_s)
+      raise StyleBuilderException.new("'#{sym}' is not a valid style") if !@__style__.respond_to?(setter_sym)
+      @__style__.send(setter_sym, value.to_s)
     end
   end
-  
+
+  # Exception thrown by StyleBuilder when an error is encountered.
+  #
   class StyleBuilderException < Exception
   end