Module: JRubyFX::Utils::CommonConverters

Included in:
Java::javafx::animation::Timeline, Java::javafx::scene::control::Pagination, Java::javafx::scene::control::ProgressBar, Java::javafx::scene::control::ProgressIndicator, Java::javafx::scene::control::TableView, Java::javafx::scene::effect::DropShadow, Java::javafx::scene::image::ImageView, Java::javafx::scene::input::DragEvent, Java::javafx::scene::layout::ColumnConstraints, Java::javafx::scene::layout::Region, Java::javafx::scene::layout::RowConstraints, Java::javafx::scene::media::MediaPlayer, Java::javafx::scene::paint::LinearGradient, Java::javafx::scene::paint::RadialGradient, Java::javafx::scene::transform::Rotate
Defined in:
lib/jrubyfx/utils/common_converters.rb

Overview

Contains conversion utilities to ease Ruby => JavaFX coding

Constant Summary collapse

ARG_CONVERTER_SUFFIX =

argument converter method name suffix

'_arg_converter'
NAME_TO_COLORS =

map of snake_cased colors to JavaFX Colors

{
'darkyellow' => Color.web('0xc0c000'),
'lightmagenta' => Color.web('0xffc0ff'),
'lightred' => Color.web('0xffc0c0'),
      }.merge(Color.java_class.fields.inject({}) {|final, field|
  final[field.name.downcase] = field.value(nil) # TODO: what is nil supposed to be?
  final
})
CONVERTERS =

Map of different kinds of known converters

{
  :none => lambda { |value|
    value
  },
  :color => lambda { |value|
    new_value = NAME_TO_COLORS[value.to_s.gsub(/_/, "")]
    if !new_value && value.kind_of?(Symbol)
      raise ArgumentError.new("No such color: #{value.to_s}") 
    end
    new_value ? new_value : value
  },
  :rectangle2d => lambda { |value|
    if value == :empty
      Rectangle2D::EMPTY
    elsif value.is_a? Array
      Rectangle2D.new(*value)
    else
      value
    end
  },
  :insets => lambda { |value|
    if value == :empty
      Insets::EMPTY
    elsif value.is_a? Numeric
      Insets.new(value)
    elsif value.is_a? Array
      # top/bottom, left/right
      value = [value[0], value[1], value[0], value[1]] if value.size == 2
      Insets.new(*value)
    else
      value
    end
  },
}
ENUM_CACHE = 
{}
ENUM_OVERRIDES =

Store enum mapping overrides

{Java::JavafxAnimation::PathTransition::OrientationType => {:orthogonal_to_tangent => :orthogonal},
Java::JavafxSceneEffect::BlendMode => {:src_over => :over, :src_atop => :atop, :color_dodge => :dodge, :color_burn => :burn},
Java::JavafxSceneControl::ContentDisplay => {:graphic_only => :graphic, :text_only => :text},
Java::JavafxSceneEffect::BlurType => {:one_pass_box => [:one, :one_pass], :two_pass_box => [:two, :two_pass], :three_pass_box => [:three, :three_pass]},
Java::JavafxStage::Modality => {:window_modal => :window, :application_modal => [:application, :app]}}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.convert_args(values, converters) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 202

def self.convert_args(values, converters)
  converter = converters.find { |e| e.length == values.length }
  converter = Array.new(values.length) unless converter

  # FIXME: Better error reporting on many things which can fail
  i = 0
  values = values.inject([]) do |s, value|
    conv = converter[i]
    if conv.kind_of? Proc
      s << conv.call(value)
    else
      s << CONVERTERS[converter[i]].call(value)
    end
    i += 1
    s
  end
  return values
end

.map_enums(enum_class) ⇒ Object

Given a class, returns a hash of lowercase strings mapped to Java Enums



187
188
189
190
191
192
193
194
195
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 187

def self.map_enums(enum_class)
  res = Hash[enum_class.java_class.enum_constants.map {|i| [i.to_s.downcase, i] }]
  (ENUM_OVERRIDES[enum_class]||[]).each do |oldk, newks|
    [newks].flatten.each do |newk|
      res[newk.to_s] = res[oldk.to_s]
    end
  end
  res
end

.parse_ruby_symbols(const, enum) ⇒ Object 



197
198
199
200
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 197

def self.parse_ruby_symbols(const, enum)
  ENUM_CACHE[enum] = JRubyFX::Utils::CommonConverters.map_enums(enum) if  ENUM_CACHE[enum] == nil
  ENUM_CACHE[enum][const.to_s] || const
end

.set_overrides_for(enum_class, ovr) ⇒ Object

sets the given overrides for the given class/enum



182
183
184
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 182

def self.set_overrides_for(enum_class,ovr)
  ENUM_OVERRIDES[enum_class] = ovr
end

Instance Method Details

#animation_converter_for(*prop_names) ⇒ Object

call-seq:

animation_converter_for :property_name, ...

Generates an animation adapter for the given properties so you can specify transformations, etc with a hashmap of from, to values

Examples

animation_converter_for :value

...

_my_type_(value: {0 => 360})



69
70
71
72
73
74
75
76
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 69

def animation_converter_for(*prop_names)
  prop_names.each do |prop_name|
    self.__send__(:define_method, prop_name.to_s + "=") do |hash|
      method("from_#{prop_name}=").call hash.keys[0]
      method("to_#{prop_name}=").call hash.values[0]
    end
  end
end

#converter_for(method_name, *converters, &default) ⇒ Object

Allows you to specify you want a converter method created for the specified method where each listed converter corresponds to each argument for that method. You can have n-arity lists for all matching Java overloads. This mechanism means you may not always be able to specify all coercions you want.

Examples

coverter_for :new, [:none, :color]

This method will define a method on the current class called new_arg_converter which will perform no argument coercion on the first argument and a color coercion on the second argument.

e = enum_converter(Java::javafx::scene::input::TransferMode)
converter_for :accept_transfer_modes &e

This method will allow a catch-all converter to be used for all arities not specified. In this case since no arities are given all arities will pass through this enum_converter. This form is useful for single var_args signatures.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 100

def converter_for(method_name, *converters, &default)
 # puts "[converter for #{self}, #{method_name}]"
  sheep = lambda do |direct, this, *values|
    converter = converters.find { |e| e.length == values.length }
    converter = Array.new(values.length, default) unless converter

    # FIXME: Better error reporting on many things which can fail
    i = 0
    values = values.inject([]) do |s, value|
      conv = converter[i]
      if conv.kind_of? Proc
        s << conv.call(value)
      else
        s << CONVERTERS[converter[i]].call(value)
      end
      i += 1
      s
    end
    if direct
      return this.method("set_" + method_name.to_s).call(*values)
    else
      return values
    end
  end
  # define a setter for normal usage
  unless method_name == :new
    self.__send__(:define_method, method_name.to_s + "=") do |*values|
      sheep.call(true, self, *values)
    end
  end
  # define a build/with usage
  self.__send__(:define_method, method_name.to_s + ARG_CONVERTER_SUFFIX) do |*values|
    sheep.call(false, self, *values)
  end
end

#enum_converter(enum_class) ⇒ Object

Generate a converter for an enum of the given class



50
51
52
53
54
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 50

def enum_converter(enum_class)
  lambda do |value|
    (JRubyFX::Utils::CommonConverters.map_enums(enum_class)[value.to_s] || value)
  end
end

#map_converter(map) ⇒ Object

Generate a converter for a map of supplied values.



42
43
44
45
46
 
# File 'lib/jrubyfx/utils/common_converters.rb', line 42

def map_converter(map)
  lambda do |value|
    map.key?(value) ? map[value] : value
  end
end