Class: OpenHAB::DSL::Sitemaps::WidgetBuilder
- Inherits:
 - 
      Object
      
        
- Object
 - OpenHAB::DSL::Sitemaps::WidgetBuilder
 
 
- Includes:
 - Core::EntityLookup
 
- Defined in:
 - lib/openhab/dsl/sitemaps/builder.rb
 
Overview
Base class for all widgets
Direct Known Subclasses
ButtonBuilder, ChartBuilder, ColorpickerBuilder, ColortemperaturepickerBuilder, DefaultBuilder, InputBuilder, LinkableWidgetBuilder, SetpointBuilder, SwitchBuilder, VideoBuilder
Instance Attribute Summary collapse
- 
  
    
      #icon  ⇒ String, ... 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The icon to show It can be a string, or a hash of conditions and icons.
 - 
  
    
      #icon_colors  ⇒ Hash<String, String>, Hash<Array<String>, String> 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Icon color rules.
 - 
  
    
      #item  ⇒ String, ... 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The item whose state to show.
 - #label ⇒ String?
 - 
  
    
      #label_colors  ⇒ Hash<String, String>, Hash<Array<String>, String> 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Label color rules.
 - 
  
    
      #static_icon  ⇒ String? 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The static icon to show This is mutually exclusive with #icon.
 - 
  
    
      #value_colors  ⇒ Hash<String, String>, Hash<Array<String>, String> 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Value color rules.
 - 
  
    
      #visibilities  ⇒ Array<String> 
    
    
  
  
  
  
    
      readonly
    
    
  
  
  
  
  
  
    
Visibility rules.
 
Instance Method Summary collapse
- 
  
    
      #icon_color(rules)  ⇒ Hash<String, String> 
    
    
  
  
  
  
  
  
  
  
  
    
Adds one or more new rules for setting the icon color.
 - 
  
    
      #label_color(rules)  ⇒ Hash<String, String> 
    
    
  
  
  
  
  
  
  
  
  
    
Adds one or more new rules for setting the label color.
 - 
  
    
      #value_color(rules)  ⇒ Hash<String, String> 
    
    
  
  
  
  
  
  
  
  
  
    
Adds one or more new rules for setting the value color.
 - 
  
    
      #visibility(*rules)  ⇒ Array<String> 
    
    
  
  
  
  
  
  
  
  
  
    
Adds one or more new visibility rules.
 
Methods included from Core::EntityLookup
#items, #method_missing, #things
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class OpenHAB::Core::EntityLookup
Instance Attribute Details
#icon ⇒ String, ...
The icon to show It can be a string, or a hash of conditions and icons.
      94 95 96  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 94 def icon @icon end  | 
  
#icon_colors ⇒ Hash<String, String>, Hash<Array<String>, String> (readonly)
Icon color rules
      112 113 114  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 112 def icon_colors @icon_colors end  | 
  
#item ⇒ String, ...
The item whose state to show
      77 78 79  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 77 def item @item end  | 
  
#label ⇒ String?
      74 75 76  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 74 def label @label end  | 
  
#label_colors ⇒ Hash<String, String>, Hash<Array<String>, String> (readonly)
Label color rules
      104 105 106  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 104 def label_colors @label_colors end  | 
  
#static_icon ⇒ String?
The static icon to show This is mutually exclusive with #icon
      100 101 102  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 100 def static_icon @static_icon end  | 
  
#value_colors ⇒ Hash<String, String>, Hash<Array<String>, String> (readonly)
Value color rules
      108 109 110  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 108 def value_colors @value_colors end  | 
  
#visibilities ⇒ Array<String> (readonly)
Visibility rules
      116 117 118  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 116 def visibilities @visibilities end  | 
  
Instance Method Details
#icon_color(rules) ⇒ Hash<String, String>
Adds one or more new rules for setting the icon color
      201 202 203 204  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 201 def icon_color(rules) rules = { default: rules } if rules.is_a?(String) @icon_colors.merge!(rules) end  | 
  
#label_color(rules) ⇒ Hash<String, String>
Adds one or more new rules for setting the label color
      187 188 189 190  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 187 def label_color(rules) rules = { default: rules } if rules.is_a?(String) @label_colors.merge!(rules) end  | 
  
#value_color(rules) ⇒ Hash<String, String>
Adds one or more new rules for setting the value color
      194 195 196 197  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 194 def value_color(rules) rules = { default: rules } if rules.is_a?(String) @value_colors.merge!(rules) end  | 
  
#visibility(*rules) ⇒ Array<String>
Adds one or more new visibility rules
      208 209 210  | 
    
      # File 'lib/openhab/dsl/sitemaps/builder.rb', line 208 def visibility(*rules) @visibilities.concat(rules) end  |