Class: UI::ListWidget

Inherits:
Window show all
Defined in:
lib/ektoplayer/ui/widgets/listwidget.rb

Instance Attribute Summary collapse

Attributes inherited from Window

#win

Attributes inherited from Widget

#pos, #size

Instance Method Summary collapse

Methods inherited from Window

#noutrefresh, #refresh

Methods inherited from Widget

#display, #events, #invisible!, #invisible?, #key_press, #keys, #lock, #mouse, #mouse_click, #mouse_event_transform, #mouse_section, #on_key_press, #on_widget_raise, #raise_widget, #refresh, #sub, #unlock, #visible!, #visible=, #visible?, #want_layout, #want_redraw, #want_refresh, #with_lock

Constructor Details

#initialize(list: [], item_renderer: nil, **opts) ⇒ ListWidget

Returns a new instance of ListWidget.



101
102
103
104
105
106
107
108
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 101

def initialize(list: [], item_renderer: nil, **opts)
   super(**opts)
   self.list=(list)
   @item_renderer = (item_renderer or ListItemRenderer.new)
   @cursor = @selected = 0
   @search = ListSearch.new
   @selection = ListSelector.new
end

Instance Attribute Details

#cursor ⇒ Object (readonly)

Returns the value of attribute cursor.



98
99
100
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 98

def cursor
  @cursor
end

#item_renderer ⇒ Object

Returns the value of attribute item_renderer.



99
100
101
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 99

def item_renderer
  @item_renderer
end

#list ⇒ Object

Returns the value of attribute list.



98
99
100
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 98

def list
  @list
end

#selected ⇒ Object

Returns the value of attribute selected.



98
99
100
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 98

def selected
  @selected
end

#selection ⇒ Object (readonly)

Returns the value of attribute selection.



98
99
100
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 98

def selection
  @selection
end

Instance Method Details

#bottom ⇒ Object 



178
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 178

def bottom;      self.selected=(index_last)                 end

#center ⇒ Object 



183
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 183

def center;      self.force_cursorpos(@size.height / 2)     end

#down(n = 1) ⇒ Object 



182
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 182

def down(n=1)    self.scroll_cursor_down(1)                 end

#draw ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 398

def draw
   @win.erase
   return if @list.empty?
   #@selected = @selected.clamp(0, index_last)

   @cursor.times do |i|
      unless @list[@selected - (@cursor - i)]
         @cursor = i
         break
      end

      write_at(i); render(@selected - (@cursor - i))
   end

   write_at(@cursor); render(@selected, selected: true)

   (@cursor + 1).upto(@size.height - 1).each_with_index do |c, i|
      break unless @list[@selected + i + 1]
      write_at(c); render(@selected + i + 1)
   end
end

#force_cursorpos(new_cursor) ⇒ Object 



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 319

def force_cursorpos(new_cursor)
   with_lock do
      if @selected <= cursor_max / 2
         @cursor = @selected
      elsif (diff = (index_last - @selected)) < cursor_max / 2
         @cursor = @size.height - diff - 1
      else
         @cursor = new_cursor.clamp(cursor_max / 2, cursor_max)
      end

      want_redraw
   end
end

#get_selection ⇒ Object 



148
149
150
151
152
153
154
155
156
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 148

def get_selection
   self.lock
   r = @selection.stop(@selected)
   r << @selected if r.empty?
   r
ensure
   want_redraw
   self.unlock
end

#layout ⇒ Object 



172
173
174
175
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 172

def layout
   @item_renderer.width = @size.width if @item_renderer
   super
end

#on_mouse_click(mevent, mevent_transformed) ⇒ Object 



420
421
422
423
424
425
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 420

def on_mouse_click(mevent, mevent_transformed)
   if new_mouse = mouse_event_transform(mevent)
      select_from_cursorpos(new_mouse.y)
   end
   super(mevent)
end

#page_down ⇒ Object 



180
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 180

def page_down;   self.scroll_list_down(@size.height)        end

#page_up ⇒ Object 



179
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 179

def page_up;     self.scroll_list_up(@size.height)          end

#render(index, **opts) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 158

def render(index, **opts)
   return unless @item_renderer
   return Ektoplayer::Application.log(self, index, caller) unless @list[index]

   opts[:selection] = (@selection.started? and
         index.between?(
            [@selection.start_pos, @selected].min,
            [@selection.start_pos, @selected].max
         )
   )

   @item_renderer.render(@win, @list[index], index, **opts)
end

#scroll_cursor_down(n) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
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
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 195

def scroll_cursor_down(n)
   fail ArgumentError unless n
   fail ArgumentError if n.negative?
   n = n.clamp(0, items_after_cursor)
   return if n == 0
   new_cursor, new_selected = @cursor + n, @selected + n

   self.lock

   # it's faster to redraw the whole screen
   if n >= @size.height
      new_cursor = cursor_max
      want_redraw
   else
      # new cursor resides in current screen
      if new_cursor <= cursor_max
         if @selection.started?
            want_redraw
         else
            write_at(@cursor); render(@selected)
            write_at(new_cursor); render(new_selected, selected: true)
            want_refresh
         end
      else
         new_cursor = cursor_max

         if @selection.started?
            want_redraw
         else
            write_at(@cursor); render(@selected)

            (index_bottom + 1).upto(new_selected - 1).each do |index|
               @win.append_bottom; render(index)
            end

            @win.append_bottom; render(new_selected, selected: true)

            want_refresh
         end
      end
   end

   @cursor, @selected = new_cursor, new_selected
ensure
   self.unlock
end

#scroll_cursor_up(n) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
284
285
286
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 242

def scroll_cursor_up(n)
   fail ArgumentError unless n
   fail ArgumentError if n.negative?
   n = n.clamp(0, items_before_cursor)
   return if n == 0
   new_cursor, new_selected = @cursor - n, @selected - n

   self.lock

   if n >= @size.height
      new_cursor = 0
      want_redraw
   else
      # new cursor resides in current screen
      if new_cursor >= 0
         if @selection.started?
            want_redraw
         else
            write_at(@cursor); render(@selected)
            write_at(new_cursor); render(new_selected, selected: true)
            want_refresh
         end
      else
         new_cursor = 0

         if @selection.started?
            want_redraw
         else
            write_at(@cursor); render(@selected)

            (index_top - 1).downto(new_selected + 1).each do |index|
               @win.insert_top; render(index)
            end

            @win.insert_top; render(new_selected, selected: true)

            want_refresh
         end
      end
   end

   @cursor, @selected = new_cursor, new_selected
ensure
   self.unlock
end

#scroll_list_down(n = 1) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 366

def scroll_list_down(n=1)
   fail ArgumentError unless n
   n = n.clamp(0, items_after_cursor)
   return if n == 0 or @list.empty?
   self.lock

   if index_bottom == index_last
      select_from_cursorpos((@cursor + n).clamp(0, cursor_max))
   elsif n < @size.height
      old_index_bottom = index_bottom
      old_selected, @selected = @selected, @selected + n

      if lines_before_cursor > n
         write_at(@cursor); render(old_selected)
      end

      (old_index_bottom + 1).upto(old_index_bottom + n).each do |index|
         @win.append_bottom; render(index)
      end

      write_at(@cursor); render(@selected, selected: true)

      want_refresh
   else
      @selected += n
      force_cursorpos(@cursor)
      want_redraw
   end

   self.unlock
end

#scroll_list_up(n = 1) ⇒ Object 



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
360
361
362
363
364
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 333

def scroll_list_up(n=1)
   fail ArgumentError unless n
   n = n.clamp(0, items_before_cursor)
   return if n == 0 or @list.empty?
   self.lock

   if index_top == 0
      # list is already on top
      select_from_cursorpos((@cursor - n).clamp(0, cursor_max))
   elsif n < @size.height
      old_index_top = index_top
      old_selected, @selected = @selected, @selected - n

      if lines_after_cursor > n
         write_at(@cursor); render(old_selected) 
      end

      (old_index_top - 1).downto(old_index_top - n).each do |index|
         @win.insert_top; render(index)
      end

      write_at(@cursor); render(@selected, selected: true)

      want_refresh
   else
      @selected -= n
      force_cursorpos(@cursor)
      want_redraw
   end

   self.unlock
end

#search_down ⇒ Object 



125
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 125

def search_down;  self.search_start(:down)    end

#search_next ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 110

def search_next
   if pos = @search.next(@selected, @list)
      self.selected=(pos)
      self.center
   end
end

#search_prev ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 117

def search_prev
   if pos = @search.prev(@selected, @list)
      self.selected=(pos)
      self.center
   end
end

#search_start(direction) ⇒ Object 



127
128
129
130
131
132
133
134
135
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 127

def search_start(direction)
   UI::Input.readline(@pos, @size.update(height: 1), prompt: '> ', add_hist: true) do |result|
      if result
         @search.direction=(direction)
         @search.search=(result)
         search_next
      end
   end
end

#search_up ⇒ Object 



124
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 124

def search_up;    self.search_start(:up)      end

#select_from_cursorpos(new_cursor) ⇒ Object

select an item by its current cursor pos



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 301

def select_from_cursorpos(new_cursor)
   fail unless new_cursor.between?(0, cursor_max)
   return if (new_cursor == @cursor) or @list.empty?

   with_lock do
      old_cursor, @cursor = @cursor, new_cursor
      old_selected, @selected = @selected, (@selected - (old_cursor - @cursor)).clamp(0, index_last)

      if @selection.started?
         want_redraw
      else
         write_at(old_cursor); render(old_selected)
         write_at(new_cursor); render(@selected, selected: true)
         want_refresh
      end
   end
end

#toggle_selection ⇒ Object 



137
138
139
140
141
142
143
144
145
146
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 137

def toggle_selection
   with_lock do
      if @selection.started?
         @selection.stop(@selected)
         want_redraw
      else
         @selection.start(@selected)
      end
   end
end

#top ⇒ Object 



177
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 177

def top;         self.selected=(0)                          end

#up(n = 1) ⇒ Object 



181
 
# File 'lib/ektoplayer/ui/widgets/listwidget.rb', line 181

def up(n=1)      self.scroll_cursor_up(1)                   end