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.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/sugarcube/uiview.rb', line 25

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

  delay = options[:delay] || 0

  # chain: true is used inside animation_chain blocks to prevent some weird
  # animation errors (nested animations do not delay/queue as you'd expect)
  if options[:chain] || Thread.current[:sugarcube_chaining]
    duration = 0
    delay = 0
    raise "Completion blocks cannot be used within an animation_chain block" if options[:after]
  end

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

  if duration == 0 && delay == 0
    animations.call
    after_adjusted.call(true) if after_adjusted
  else
    UIView.animateWithDuration( duration,
                         delay: delay,
                       options: options[:options] || (UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionBeginFromCurrentState),
                    animations: animations,
                    completion: after_adjusted
                              )
  end
  nil
end

.animation_chain(options = {}, &first) ⇒ Object

Animation chains are great for consecutive animation blocks. Each chain can take the same options that UIView##animate take.



70
71
72
73
74
75
76
 
# File 'lib/sugarcube/uiview.rb', line 70

def animation_chain(options={}, &first)
  chain = SugarCube::AnimationChain.new
  if first
    chain.and_then(options, &first)
  end
  return chain
end

.attr_updates(*attrs) ⇒ Object 



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

def attr_updates(*attrs)
  attr_accessor(*attrs)
  attrs.each do |attr|
    define_method("#{attr}=") { |value|
      if instance_variable_get("@#{attr}") != value
        setNeedsDisplay
      end
      instance_variable_set("@#{attr}", value)
    }
  end
end

.first_responder ⇒ Object

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



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

def first_responder
  UIApplication.sharedApplication.keyWindow.first_responder
end

Instance Method Details

#<<(view) ⇒ Object

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



110
111
112
113
 
# File 'lib/sugarcube/uiview.rb', line 110

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

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

Same as UIView##animate, but acts on self



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/sugarcube/uiview.rb', line 131

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.



98
99
100
101
102
103
104
105
106
 
# File 'lib/sugarcube/uiview.rb', line 98

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

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



220
221
222
223
224
225
226
227
 
# File 'lib/sugarcube/uiview.rb', line 220

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

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

Changes the layer opacity.



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

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

  options[:after] = after

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

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

Changes the layer opacity to 1.

See Also:



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

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:



166
167
168
169
170
171
172
173
174
 
# File 'lib/sugarcube/uiview.rb', line 166

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:



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/sugarcube/uiview.rb', line 190

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

  original_opacity = self.alpha

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

  fade_out(options, &after_remove)
end

#first_responder ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/sugarcube/uiview.rb', line 81

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 



125
126
127
128
 
# File 'lib/sugarcube/uiview.rb', line 125

def hide
  self.hidden = true
  self
end

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



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/sugarcube/uiview.rb', line 206

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, &proc)
  direction = nil
  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

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

Changes the current rotation by new_angle (rotate rotates to a specific angle)



245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/sugarcube/uiview.rb', line 245

def rotate(options={}, &after)
  if options.is_a? Numeric
    new_angle = options
    options = {}
  else
    new_angle = options[:angle]
  end

  old_angle = valueForKeyPath('layer.transform.rotation.z')
  options[:angle] = old_angle + new_angle
  rotate_to(options, &after)
end

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

Changes the current rotation to new_angle (rotate rotates relative to the current rotation)



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/sugarcube/uiview.rb', line 231

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

  options[:after] = after

  animate(options) {
    self.transform = CGAffineTransformMakeRotation(options[:angle])
  }
end

#shake(options = {}) ⇒ Object

Vibrates the target. You can trick this thing out to do other effects, like:

Examples:

# wiggle
view.shake(offset: 0.1, repeat: 2, duration: 0.5, keypath: 'transform.rotation')
# slow nodding
view.shake(offset: 20, repeat: 10, duration: 5, keypath: 'transform.translation.y')


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/sugarcube/uiview.rb', line 291

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.send(:'setDuration:', 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 



120
121
122
123
 
# File 'lib/sugarcube/uiview.rb', line 120

def show
  self.hidden = false
  self
end

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/sugarcube/uiview.rb', line 258

def slide(direction, options={}, more_options=nil, &after)
  if options.is_a? Numeric
    size = options
    options = more_options || {}
  else
    size = options[:size]
  end

  case direction
  when :left
    size ||= self.bounds.size.width
    delta_to([-size, 0], options, &after)
  when :right
    size ||= self.bounds.size.width
    delta_to([size, 0], options, &after)
  when :up
    size ||= self.bounds.size.height
    delta_to([0, -size], options, &after)
  when :down
    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

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

Moves the view off screen while slowly rotating it.

Based on https://github.com/warrenm/AHAlertView/blob/master/AHAlertView/AHAlertView.m



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/sugarcube/uiview.rb', line 324

def tumble(options={}, &after)
  if options.is_a? Numeric
    default_duration = options
    options = {}
  else
    default_duration = 0.3
  end

  options[:duration] ||= default_duration
  options[:options] ||= UIViewAnimationOptionCurveEaseIn|UIViewAnimationOptionBeginFromCurrentState
  reset_transform = self.transform
  reset_after = ->(finished) {
    self.transform = reset_transform
  }

  if after
    options[:after] = ->(finished) {
      reset_after.call(finished)

      if after.arity == 0
        after.call
      else
        after.call(finished)
      end
    }
  else
    options[:after] = reset_after
  end

  self.animate(options) {
     offset = CGPoint.new(0, self.superview.bounds.size.height * 1.5)
     offset = CGPointApplyAffineTransform(offset, self.transform)
     self.transform = CGAffineTransformConcat(self.transform, CGAffineTransformMakeRotation(-Math::PI/4))
     self.center = CGPointMake(self.center.x + offset.x, self.center.y + offset.y)
  }
end

#uiimage(use_content_size = false) ⇒ Object

Easily take a snapshot of a UIView.

Calling uiimage with no arguments will return the image based on the bounds of the image. In the case of container views (notably UIScrollView and its children) this does not include the entire contents, which is something you probably want.

If you pass a truthy value to this method, it will use the contentSize of the view instead of the bounds, and it will draw all the child views, not just those that are visible in the viewport.

It is guaranteed that true and :all will always have this behavior. In the future, if this argument becomes something that accepts multiple values, those two are sacred.



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/sugarcube/uiview.rb', line 375

def uiimage(use_content_size=false)
  scale = UIScreen.mainScreen.scale
  if use_content_size
    UIGraphicsBeginImageContextWithOptions(contentSize, false, scale)
    context = UIGraphicsGetCurrentContext()
    subviews.each do |subview|
      CGContextSaveGState(context)
      CGContextTranslateCTM(context, subview.frame.origin.x, subview.frame.origin.y)
      subview.layer.renderInContext(context)
      CGContextRestoreGState(context)
    end
    image = UIGraphicsGetImageFromCurrentImageContext()
    UIGraphicsEndImageContext()
  else
    UIGraphicsBeginImageContextWithOptions(bounds.size, false, scale)
    layer.renderInContext(UIGraphicsGetCurrentContext())
    image = UIGraphicsGetImageFromCurrentImageContext()
    UIGraphicsEndImageContext()
  end
  return image
end

#unshift(view) ⇒ Object 



115
116
117
118
 
# File 'lib/sugarcube/uiview.rb', line 115

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