Class: UIView

Inherits:
Object show all
Defined in:
lib/sugarcube-gestures/gestures.rb,
lib/sugarcube/uiview.rb,
lib/sugarcube/to_s/uiview.rb

Overview

BubbleWrap has these same methods, but the logic and options are a little different. In the spirit of open source, I am blatantly copying their code, changing it to suit my needs, and offering it here

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.animate(options = {}, &animations) ⇒ Object

If options is a Numeric, it is used as the duration. Otherwise, duration is an option, and defaults to 0.3. All the transition methods work this way.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sugarcube/uiview.rb', line 63

def self.animate(options={}, &animations)
  if options.is_a? Numeric
    duration = options
    options = {}
  else
    duration = options[:duration] || 0.3
  end

  after_animations = options[:after]
  if after_animations
    if after_animations.arity == 0
      after_adjusted = proc { |finished| after_animations.call }
    else
      after_adjusted = proc { |finished| after_animations.call(finished) }
    end
  else
    after_adjusted = nil
  end

  UIView.animateWithDuration( duration,
                       delay: options[:delay] || 0,
                     options: options[:options] || UIViewAnimationOptionCurveEaseInOut,
                  animations: proc,
                  completion: after_adjusted
                            )
  nil
end

.first_responder ⇒ Object

returns the first responder, starting at the Window and searching every subview



5
6
7
 
# File 'lib/sugarcube/uiview.rb', line 5

def first_responder
  UIApplication.sharedApplication.keyWindow.first_responder
end

Instance Method Details

#<<(view) ⇒ Object

superview << view => superview.addSubview(view)



40
41
42
43
 
# File 'lib/sugarcube/uiview.rb', line 40

def <<(view)
  self.addSubview(view)
  return self
end

#animate(options = {}, &animations) ⇒ Object

Same as UIView##animate, but acts on self



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/sugarcube/uiview.rb', line 92

def animate(options={}, &animations)
  if options.is_a? Numeric
    duration = options
    options = {}
  else
    duration = options[:duration] || 0.3
  end

  assign = options[:assign] || {}

  UIView.animate(options) {
    animations.call if animations

    assign.each_pair do |key, value|
      self.send("#{key}=", value)
    end
  }
  self
end

#controller ⇒ Object

returns the nearest nextResponder instance that is a UIViewController. Goes up the responder chain until the nextResponder is a UIViewController subclass, or returns nil if none is found.



28
29
30
31
32
33
34
35
36
 
# File 'lib/sugarcube/uiview.rb', line 28

def controller
  if nextResponder && nextResponder.is_a?(UIViewController)
    nextResponder
  elsif nextResponder
    nextResponder.controller
  else
    nil
  end
end

#delta_to(delta, options = {}, &after) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/sugarcube/uiview.rb', line 181

def delta_to(delta, options={}, &after)
  f = self.frame
  delta = SugarCube::CoreGraphics::Point(delta)
  position = SugarCube::CoreGraphics::Point(f.origin)
  move_to(position + delta, options, &after)
  self
end

#fade(options = {}, &after) ⇒ Object

Changes the layer opacity.



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/sugarcube/uiview.rb', line 113

def fade(options={}, &after)
  if options.is_a? Numeric
    options = { opacity: options }
  end

  options[:after] ||= after

  animate(options) {
    self.layer.opacity = options[:opacity]
  }
end

#fade_in(options = {}, &after) ⇒ Object

Changes the layer opacity to 1.

See Also:



139
140
141
142
143
144
145
146
147
 
# File 'lib/sugarcube/uiview.rb', line 139

def fade_in(options={}, &after)
  if options.is_a? Numeric
    options = { duration: options }
  end

  options[:opacity] ||= 1.0

  fade(options, &after)
end

#fade_out(options = {}, &after) ⇒ Object

Changes the layer opacity to 0.

See Also:



127
128
129
130
131
132
133
134
135
 
# File 'lib/sugarcube/uiview.rb', line 127

def fade_out(options={}, &after)
  if options.is_a? Numeric
    options = { duration: options }
  end

  options[:opacity] ||= 0.0

  fade(options, &after)
end

#fade_out_and_remove(options = {}, &after) ⇒ Object

Changes the layer opacity to 0 and then removes the view from its superview

See Also:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/sugarcube/uiview.rb', line 151

def fade_out_and_remove(options={}, &after)
  if options.is_a? Numeric
    options = { duration: options }
  end

  original_opacity = self.layer.opacity

  after_remove = proc {
    removeFromSuperview
    self.layer.opacity = original_opacity
    after.call if after
  }

  fade_out(options, &after_remove)
end

#first_responder ⇒ Object

returns the first responder, or nil if it cannot be found



11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/sugarcube/uiview.rb', line 11

def first_responder
  if self.firstResponder?
    return self
  end

  found = nil
  self.subviews.each do |subview|
    found = subview.first_responder
    break if found
  end

  return found
end

#hide ⇒ Object 



55
56
57
58
 
# File 'lib/sugarcube/uiview.rb', line 55

def hide
  self.hidden = true
  self
end

#move_to(position, options = {}, &after) ⇒ Object 



167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/sugarcube/uiview.rb', line 167

def move_to(position, options={}, &after)
  if options.is_a? Numeric
    options = { duration: options }
  end

  options[:after] ||= after

  animate(options) {
    f = self.frame
    f.origin = SugarCube::CoreGraphics::Point(position)
    self.frame = f
  }
end

#on_gesture(recognizer) ⇒ Object #on_gesture(recognizer_class) ⇒ Object

A generic gesture adder, but accepts a block like the other gesture methods

Examples:

Using a UIGestureRecognizer class

view.on_gesture(UISwipeGestureRecognizer, direction: UISwipeGestureRecognizerDirectionLeft) { puts "swiped left" }

Using a UIGestureRecognizer instance

gesture = UISwipeGestureRecognizer
gesture.direction = UISwipeGestureRecognizerDirectionLeft
view.on_gesture(gesture) { puts "swiped left" }

Overloads:

  • #on_gesture(recognizer) ⇒ Object

    Adds the gesture to the view, and yields the block when the gesture is recognized

  • #on_gesture(recognizer_class) ⇒ Object

    Instantiates a gesture and adds it to the view.

Parameters:

  • options (Hash) (defaults to: {}) —

    method/value pairs to call on the gesture.

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/sugarcube-gestures/gestures.rb', line 19

def on_gesture(klass, options={}, &proc)
  if klass.is_a? UIGestureRecognizer
    recognizer = klass
    recognizer.addTarget(self, action:'sugarcube_handle_gesture:')
  else
    recognizer = klass.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  end

  options.each do |method, value|
    recognizer.send(method, value)
  end
  sugarcube_add_gesture(proc, recognizer)
end

#on_tap(taps) ⇒ Object #on_tap(options) ⇒ Object

Overloads:

  • #on_tap(taps) ⇒ Object

    Parameters:

    • taps (Fixnum) —

      Number of taps

  • #on_tap(options) ⇒ Object

    Options Hash (options):

    • :min_fingers (Fixnum) —

      Minimum umber of fingers for gesture to be recognized

    • :max_fingers (Fixnum) —

      Maximum number of fingers for gesture to be recognized

    • :fingers (Fixnum) —

      If min_fingers or max_fingers is not assigned, this will be the default.

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/sugarcube-gestures/gestures.rb', line 113

def on_pan(fingers_or_options=nil, &proc)
  fingers = nil
  min_fingers = nil
  max_fingers = nil

  if fingers_or_options
    if fingers_or_options.is_a? Hash
      fingers = fingers_or_options[:fingers] || fingers
      min_fingers = fingers_or_options[:min_fingers] || min_fingers
      max_fingers = fingers_or_options[:max_fingers] || max_fingers
    else
      fingers = fingers_or_options
    end
  end

  # if fingers is assigned, but not min/max, assign it as a default
  min_fingers ||= fingers
  max_fingers ||= fingers

  recognizer = UIPanGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  recognizer.maximumNumberOfTouches = min_fingers if min_fingers
  recognizer.minimumNumberOfTouches = max_fingers if max_fingers
  sugarcube_add_gesture(proc, recognizer)
end

#on_pinch {|recognizer| ... } ⇒ Object

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



59
60
61
62
 
# File 'lib/sugarcube-gestures/gestures.rb', line 59

def on_pinch(&proc)
  recognizer = UIPinchGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  sugarcube_add_gesture(proc, recognizer)
end

#on_press(duration) ⇒ Object #on_tap(options) ⇒ Object

Overloads:

  • #on_press(duration) ⇒ Object

    Parameters:

    • duration (Fixnum) —

      How long in seconds before gesture is recognized

  • #on_tap(options) ⇒ Object

    Options Hash (options):

    • :duration (Fixnum) —

      How long in seconds before gesture is recognized

    • :taps (Fixnum) —

      Number of taps before gesture is recognized

    • :fingers (Fixnum) —

      Number of fingers before gesture is recognized

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/sugarcube-gestures/gestures.rb', line 145

def on_press(duration_or_options=nil, &proc)
  duration = nil
  taps = nil
  fingers = nil

  if duration_or_options
    if duration_or_options.is_a? Hash
      duration = duration_or_options[:duration] || duration
      taps = duration_or_options[:taps] || taps
      fingers = duration_or_options[:fingers] || fingers
    else
      duration = duration_or_options
    end
  end

  recognizer = UILongPressGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  recognizer.minimumPressDuration = duration if duration
  recognizer.numberOfTapsRequired = taps if taps
  recognizer.numberOfTouchesRequired = fingers if fingers
  sugarcube_add_gesture(proc, recognizer)
end

#on_rotate {|recognizer| ... } ⇒ Object

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



65
66
67
68
 
# File 'lib/sugarcube-gestures/gestures.rb', line 65

def on_rotate(&proc)
  recognizer = UIRotationGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  sugarcube_add_gesture(proc, recognizer)
end

#on_swipe(taps) ⇒ Object #on_swipe(options) ⇒ Object

Overloads:

  • #on_swipe(taps) ⇒ Object

    Parameters:

    • direction (Fixnum) —

      Direction of swipe

  • #on_swipe(options) ⇒ Object

    Options Hash (options):

    • :fingers (Fixnum) —

      Number of fingers before gesture is recognized

    • :direction (Fixnum, Symbol) —

      Direction of swipe, as a UISwipeGestureRecognizerDirection constant or a symbol (:left, :right, :up, :down)

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/sugarcube-gestures/gestures.rb', line 76

def on_swipe(direction_or_options=nil, &proc)
  direction = UISwipeGestureRecognizerDirectionRight
  fingers = nil

  if direction_or_options
    if direction_or_options.is_a? Hash
      direction = direction_or_options[:direction] || direction
      fingers = direction_or_options[:fingers] || fingers
    else
      direction = direction_or_options
    end
  end

  case direction
  when :left
    direction = UISwipeGestureRecognizerDirectionLeft
  when :right
    direction = UISwipeGestureRecognizerDirectionRight
  when :up
    direction = UISwipeGestureRecognizerDirectionUp
  when :down
    direction = UISwipeGestureRecognizerDirectionDown
  end

  recognizer = UISwipeGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  recognizer.direction = direction if direction
  recognizer.numberOfTouchesRequired = fingers if fingers
  sugarcube_add_gesture(proc, recognizer)
end

#on_tap(taps) ⇒ Object #on_tap(options) ⇒ Object

Overloads:

  • #on_tap(taps) ⇒ Object

    Parameters:

    • taps (Fixnum) —

      Number of taps

  • #on_tap(options) ⇒ Object

    Options Hash (options):

    • :taps (Fixnum) —

      Number of taps before gesture is recognized

    • :fingers (Fixnum) —

      Number of fingers before gesture is recognized

Yields:

  • (recognizer) —

    Handles the gesture event, and passes the recognizer instance to the block.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/sugarcube-gestures/gestures.rb', line 39

def on_tap(taps_or_options=nil, &proc)
  taps = nil
  fingers = nil

  if taps_or_options
    if taps_or_options.is_a? Hash
      taps = taps_or_options[:taps] || taps
      fingers = taps_or_options[:fingers] || fingers
    else
      taps = taps_or_options
    end
  end

  recognizer = UITapGestureRecognizer.alloc.initWithTarget(self, action:'sugarcube_handle_gesture:')
  recognizer.numberOfTapsRequired = taps if taps
  recognizer.numberOfTouchesRequired = fingers if fingers
  sugarcube_add_gesture(proc, recognizer)
end

#shake(options = {}) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/sugarcube/uiview.rb', line 213

def shake(options={})
  if options.is_a? Numeric
    duration = options
    options = {}
  else
    duration = options[:duration] || 0.3
  end

  offset = options[:offset] || 8
  repeat = options[:repeat] || 3
  if repeat == Float::INFINITY
    duration = 0.1
  else
    duration /= repeat
  end
  keypath = options[:keypath] || 'transform.translation.x'

  origin = options[:origin] || 0
  left = origin - offset
  right = origin + offset

  animation = CAKeyframeAnimation.animationWithKeyPath(keypath)
  animation.duration = duration
  animation.repeatCount = repeat
  animation.values = [origin, left, right, origin]
  animation.keyTimes = [0, 0.25, 0.75, 1.0]
  self.layer.addAnimation(animation, forKey:'shake')
  self
end

#show ⇒ Object 



50
51
52
53
 
# File 'lib/sugarcube/uiview.rb', line 50

def show
  self.hidden = false
  self
end

#slide(direction, options = {}, &after) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/sugarcube/uiview.rb', line 189

def slide(direction, options={}, &after)
  if options.is_a? Numeric
    options = {size: options}
  end

  case direction
  when :left
    size = options[:size] || self.bounds.size.width
    delta_to([-size, 0], options, &after)
  when :right
    size = options[:size] || self.bounds.size.width
    delta_to([+size, 0], options, &after)
  when :up
    size = options[:size] || self.bounds.size.height
    delta_to([0, -size], options, &after)
  when :down
    size = options[:size] || self.bounds.size.height
    delta_to([0, +size], options, &after)
  else
    raise "Unknown direction #{direction.inspect}"
  end
  self
end

#to_s(options = {}) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/sugarcube/to_s/uiview.rb', line 3

def to_s(options={})
  options[:superview] = true if options[:superview].nil?
  if self.respond_to? :stylename and self.stylename
    suffix = ' stylename: ' + self.stylename.inspect
  else
    suffix = ''
  end
  if options[:inner].is_a? Hash
    inner = ''
    options[:inner].each do |key, value|
      inner += ', ' if inner.length > 0
      inner += "#{key}: #{value.inspect}"
    end
  else
    inner = options[:inner]
  end

  "#{self.class.name}(##{self.object_id.to_s(16)}, #{SugarCube::Adjust::format_frame(self.frame)}" +
                      (inner ? ', ' + inner : '') +
                      ')' +
                      (options[:superview] && self.superview ? ", child of #{self.superview.class.name}(##{self.superview.object_id.to_s(16)})" : '') +
                      suffix
end

#unshift(view) ⇒ Object 



45
46
47
48
 
# File 'lib/sugarcube/uiview.rb', line 45

def unshift(view)
  self.insertSubview(view, atIndex:0)
  return self
end