# FrameInRuby
# Copyright, Keith Bennett, 2009
require 'java'
# In Java, classes in the java.lang package do not need to be imported.
# In JRuby, they do, so that JRuby can distinguish it from a Ruby constant.
import java.lang.Double
import java.lang.NumberFormatException
# In the Java version of the program, it was necessary to import Dimension
# because it was needed to define the type of a variable. In Ruby, it is
# not necessary to specify the type of a variable's value, so we never
# use the term 'Dimension', and there is no need to import it.
import java.awt.BorderLayout
import java.awt.Event
import java.awt.GridLayout
import java.awt.Toolkit
import java.awt.event.KeyEvent
import javax.swing.AbstractAction
import javax.swing.Action
import javax.swing.BorderFactory
import javax.swing.JButton
import javax.swing.JFrame
import javax.swing.JLabel
import javax.swing.JMenu
import javax.swing.JMenuBar
import javax.swing.JPanel
import javax.swing.JTextField
import javax.swing.KeyStroke
# In Java, all classes specified in the same package as the file being compiled
# will be found by the compiler without explicitly importing them. In contrast,
# in Ruby, we need to "require" files, even though they are in the same
# directory as the file being interpreted.
# =======================================================================
# TemperatureConversion module
# =======================================================================
module TemperatureConversion
# Converts a temperature from Fahrenheit to Celsius.
def f2c(f)
((f - 32) * 5.0 / 9.0)
end
# Converts a temperature from Celsius to Fahrenheit.
def c2f(c)
(c * 9.0 / 5.0) + 32
end
end
# =======================================================================
# FrameInRuby class
# =======================================================================
# Main application frame containing menus, text fields for the temperatures,
# and buttons. The menu items and buttons are driven by shared actions,
# which are disabled and enabled based on the state of the text fields.
#
# Temperatures can be converted in either direction, Fahrenheit to Celsius
# or Celsius to Fahrenheit. The convert actions (F2C, C2F) are each enabled
# when the respective source text field (F for F2C, C for C2F) contains text
# that can successfully be parsed to a Double.
#
# The Clear action is enabled when there is any text in either of the text fields.
class FrameInRuby < JFrame
include TemperatureConversion
attr_accessor :fahr_text_field, :cels_text_field
# These actions will be shared by menu items and buttons.
attr_accessor :f2c_action, :c2f_action, :clear_action, :exit_action
# Sets up frame with all components, centers on screen,
# and sets it up to exit the program when closed.
def initialize
super "Fahrenheit <--> Celsius Converter"
# In Ruby, the double colon is used to refer to static data members
# (class variables as opposed to instance variables):
getContentPane.add create_converters_panel, BorderLayout::CENTER
setup_actions
getContentPane.add create_buttons_panel, BorderLayout::SOUTH
setJMenuBar create_menu_bar
getContentPane.setBorder(BorderFactory.createEmptyBorder(12, 12, 12, 12))
setDefaultCloseOperation(JFrame::EXIT_ON_CLOSE)
pack
centerOnScreen
end
# Creates the Fahrenheit and Celsius text fields.
def create_text_fields
# Note that in JRuby we can use lambdas as lightweight nested functions
# to increase DRYness:
create_field = lambda do
f = JTextField.new(15);
f.setToolTipText "Input a temperature."
f
end
self.fahr_text_field = create_field.call
self.cels_text_field = create_field.call
setup_text_field_listeners
end
# Creates the panel containing the Fahrenheit and Celsius labels
# and text fields.
def create_converters_panel
# Another lambda as lightweight nested function:
create_an_inner_panel = lambda { JPanel.new(GridLayout.new(0, 1, 5, 5))}
labelPanel = create_an_inner_panel.call
labelPanel.add(JLabel.new("Fahrenheit: "))
labelPanel.add(JLabel.new("Celsius: "))
create_text_fields
textFieldPanel = create_an_inner_panel.call
textFieldPanel.add(fahr_text_field)
textFieldPanel.add(cels_text_field)
panel = JPanel.new(BorderLayout.new())
panel.add(labelPanel, BorderLayout::WEST)
panel.add(textFieldPanel, BorderLayout::CENTER)
panel
end
# Creates the menu bar with File, Edit, and Convert menus.
def create_menu_bar
menubar = JMenuBar.new
file_menu = JMenu.new "File"
file_menu.add exit_action
menubar.add file_menu
edit_menu = JMenu.new "Edit"
edit_menu.add clear_action
menubar.add edit_menu
convert_menu = JMenu.new "Convert"
convert_menu.add f2c_action
convert_menu.add c2f_action
menubar.add convert_menu
menubar
end
# Sets up the listeners that will determine the enabled states of the
# temperature conversion (f2c and c2f) and clear actions.
def setup_text_field_listeners
# In Java, a separate class is required for each type
# of action. In contrast, Ruby supports code blocks, lambdas, and procs.
# This allows us to use instances of the same SimpleDocumentListener
# class simply creating them with different lambdas.
clear_enabler = lambda {
ctext = cels_text_field.getText
ftext = fahr_text_field.getText
should_enable =
(ctext && ctext.length > 0) ||
(ftext && ftext.length > 0)
clear_action.setEnabled should_enable
}
fahr_text_field.getDocument.addDocumentListener(
SimpleDocumentListener.new do
f2c_action.setEnabled double_string_valid?(fahr_text_field.getText)
end)
cels_text_field.getDocument.addDocumentListener(
SimpleDocumentListener.new do
c2f_action.setEnabled double_string_valid?(cels_text_field.getText)
end)
clear_document_listener = SimpleDocumentListener.new &clear_enabler
fahr_text_field.getDocument.addDocumentListener clear_document_listener
cels_text_field.getDocument.addDocumentListener clear_document_listener
end
# Sets up the temperature conversion, clear, and exit actions, including
# name, behavior, tooltip, and accelerator key.
def setup_actions
self.f2c_action = SwingAction.new("Fahr --> Cels",
Action::SHORT_DESCRIPTION => "Convert from Fahrenheit to Celsius",
Action::ACCELERATOR_KEY =>
KeyStroke.getKeyStroke(KeyEvent::VK_S, Event::CTRL_MASK),
&f2c_behavior)
f2c_action.setEnabled false
self.c2f_action = SwingAction.new("Cels --> Fahr",
Action::SHORT_DESCRIPTION => "Convert from Celsius to Fahrenheit",
Action::ACCELERATOR_KEY =>
KeyStroke.getKeyStroke(KeyEvent::VK_T, Event::CTRL_MASK),
& c2f_behavior)
c2f_action.setEnabled false
self.exit_action = SwingAction.new("Exit",
Action::SHORT_DESCRIPTION => "Exit this program",
Action::ACCELERATOR_KEY =>
KeyStroke.getKeyStroke(KeyEvent::VK_X, Event::CTRL_MASK))\
do |event|
java.lang.System::exit 0
end
self.clear_action = SwingAction.new("Clear",
Action::SHORT_DESCRIPTION => "Reset to empty the temperature fields",
Action::ACCELERATOR_KEY =>
KeyStroke.getKeyStroke(KeyEvent::VK_L, Event::CTRL_MASK),
&clear_behavior)
clear_action.setEnabled false
end
# Creates the button panel laid out such that the buttons will always
# stay at the right side of the window.
def create_buttons_panel
innerPanel = JPanel.new(GridLayout.new(1, 0, 5, 5))
innerPanel.add(JButton.new f2c_action)
innerPanel.add(JButton.new c2f_action)
innerPanel.add(JButton.new clear_action)
innerPanel.add(JButton.new exit_action)
outerPanel = JPanel.new(BorderLayout.new())
outerPanel.add innerPanel, BorderLayout::EAST
outerPanel.setBorder(BorderFactory.createEmptyBorder(10, 0, 0, 0))
outerPanel
end
# Defines and returns the behavior for the Fahrenheit to Celsius conversion.
def f2c_behavior
lambda do |event|
text = fahr_text_field.getText
if text != nil and text.length > 0
fahr = Double::parseDouble(text)
cels = f2c fahr
cels_text = Double::toString(cels)
cels_text_field.setText cels_text
end
end
end
# Defines and returns the behavior for the Celsius to Fahrenheit conversion.
def c2f_behavior
lambda do |event|
text = cels_text_field.getText
if text != nil and text.length > 0
cels = Double::parseDouble(text)
fahr = c2f cels
fahr_text = Double::toString(fahr)
fahr_text_field.setText fahr_text
end
end
end
# Defines and returns the behavior for the clear action.
def clear_behavior
lambda do |event|
fahr_text_field.setText ''
cels_text_field.setText ''
end
end
# A nice touch in Ruby is the ability to name functions with names
# that end in "?" to indicate that they return a boolean value.
def double_string_valid?(str)
begin
Double::parseDouble(str) # convert but discard converted value
is_valid = true
rescue NumberFormatException
is_valid = false
end
is_valid
end
# Centers the window on the screen based on the graphical information
# reported by the java.awt.Toolkit. Note that in some cases, such as
# use of multiple nonmirrored displays, the position may be odd, since
# the toolkit may report the sum of all display space across all available
# displays.
def centerOnScreen
screenSize = Toolkit.getDefaultToolkit().getScreenSize()
componentSize = getSize()
new_x = (screenSize.getWidth() - componentSize.getWidth()) / 2
new_y = (screenSize.getHeight() - componentSize.getHeight()) / 2
setLocation(new_x, new_y)
end
end
# =======================================================================
# SimpleDocumentListener class
# =======================================================================
# Simple implementation of javax.swing.event.DocumentListener that
# enables specifying a single code block that will be called
# when any of the three DocumentListener methods are called.
#
# Note that unlike Java, where it is necessary to subclass the abstract
# Java class SimpleDocumentListener, we can merely create an instance of
# the Ruby class SimpleDocumentListener with the code block we want
# executed when a DocumentEvent occurs. This code can be in the form of
# a code block, lambda, or proc.
import javax.swing.event.DocumentListener
class SimpleDocumentListener
# This is how we declare that this class implements the Java
# DocumentListener interface in JRuby:
include DocumentListener
attr_accessor :behavior
def initialize(&behavior)
self.behavior = behavior
end
def changedUpdate(event); behavior.call event; end
def insertUpdate(event); behavior.call event; end
def removeUpdate(event); behavior.call event; end
end
# =======================================================================
# SwingAction class
# =======================================================================
# When running FrameInRuby, this will generate a warning because
# it is already imported in FrameInRuby. In JRuby, unfortunately,
# imports of Java classes are not confined to the file
# in which they are specified; once you import a class,
# it will be imported for other classes as well.
# This may be fixed in a future version of JRuby.
import javax.swing.AbstractAction
# This class enables the specification of a Swing action
# in a format natural to Ruby.
#
# It takes and stores a code block, lambda, or proc as the
# action's behavior, so there is no need to define a new class
# for each behavior. Also, it allows the optional specification
# of the action's properties via the passing of hash entries,
# which are effectively named parameters.
class SwingAction < AbstractAction
attr_accessor :behavior
# Creates the action object with a behavior, name, and options:
#
# behavior - a behavior can be a code block, lambda,
# or a Proc.
#
# name - this is the name that will be used for the menu option,
# button caption, etc. Note that if an app is internationalized,
# the name will vary by locale, so it is better to identify an action
# by the action instance itself rather than its name.
#
# options - these are hash entries that will be passed to
# AbstractAction.putValue(). Keys should be constants from the
# javax.swing.Action interface, such as Action.SHORT_DESCRIPTION.
# Ruby allows hash entries to passed as the last parameters to a
# function, and they can be accessed inside the method as a single
# hash object.
#
# Example:
#
# self.exit_action = SwingAction.new(
# "Exit",
# Action::SHORT_DESCRIPTION => "Exit this program",
# Action::ACCELERATOR_KEY =>
# KeyStroke.getKeyStroke(KeyEvent::VK_X, Event::CTRL_MASK)) do
# System.exit 0
# end
#
def initialize(name, options=nil, &behavior)
super name
options.each { |key, value| putValue key, value } if options
self.behavior = behavior
end
def actionPerformed(action_event)
behavior.call action_event
end
end
# =======================================================================
# Program entry point:
# =======================================================================
FrameInRuby.new.setVisible true
