Class: ActionController::Pagination::Paginator::Page

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/action_controller/pagination.rb

Overview

A class representing a single page in a paginator.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(paginator, number) ⇒ Page

Creates a new Page for the given paginator with the index number. If number is not in the range of valid page numbers or is not a number at all, it defaults to 1.



267
268
269
270
271
 
# File 'lib/action_controller/pagination.rb', line 267

def initialize(paginator, number)
  @paginator = paginator
  @number = number.to_i
  @number = 1 unless @paginator.has_page_number? @number
end

Instance Attribute Details

#number ⇒ Object (readonly) Also known as: to_i

Returns the value of attribute number.



272
273
274
 
# File 'lib/action_controller/pagination.rb', line 272

def number
  @number
end

#paginator ⇒ Object (readonly)

Returns the value of attribute paginator.



272
273
274
 
# File 'lib/action_controller/pagination.rb', line 272

def paginator
  @paginator
end

Instance Method Details

#<=>(page) ⇒ Object

Compares two Page objects and returns -1 if the left-hand page comes before the right-hand page, 0 if the pages are equal, and 1 if the left-hand page comes after the right-hand page. Raises ArgumentError if the pages do not belong to the same Paginator object.

Raises:

  • (ArgumentError) 


288
289
290
291
 
# File 'lib/action_controller/pagination.rb', line 288

def <=>(page)
  raise ArgumentError unless @paginator == page.paginator
  @number <=> page.number
end

#==(page) ⇒ Object

Compares two Page objects and returns true when they represent the same page (i.e., their paginators are the same and they have the same page number).



278
279
280
281
282
 
# File 'lib/action_controller/pagination.rb', line 278

def ==(page)
  return false if page.nil?
  @paginator == page.paginator and 
    @number == page.number
end

#first? ⇒ Boolean

Returns true if this page is the first page in the paginator.

Returns:

  • (Boolean) 


309
310
311
 
# File 'lib/action_controller/pagination.rb', line 309

def first?
  self == @paginator.first
end

#first_item ⇒ Object

Returns the number of the first item displayed.



299
300
301
 
# File 'lib/action_controller/pagination.rb', line 299

def first_item
  offset + 1
end

#last? ⇒ Boolean

Returns true if this page is the last page in the paginator.

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/action_controller/pagination.rb', line 314

def last?
  self == @paginator.last
end

#last_item ⇒ Object

Returns the number of the last item displayed.



304
305
306
 
# File 'lib/action_controller/pagination.rb', line 304

def last_item
  [@paginator.items_per_page * @number, @paginator.item_count].min
end

#next ⇒ Object

Returns a new Page object representing the page just after this page, or nil if this is the last page.



326
327
328
 
# File 'lib/action_controller/pagination.rb', line 326

def next
  if last? then nil else Page.new(@paginator, @number + 1) end
end

#offset ⇒ Object

Returns the item offset for the first item in this page.



294
295
296
 
# File 'lib/action_controller/pagination.rb', line 294

def offset
  @paginator.items_per_page * (@number - 1)
end

#previous ⇒ Object

Returns a new Page object representing the page just before this page, or nil if this is the first page.



320
321
322
 
# File 'lib/action_controller/pagination.rb', line 320

def previous
  if first? then nil else Page.new(@paginator, @number - 1) end
end

#to_param ⇒ Object

:nodoc:



341
342
343
 
# File 'lib/action_controller/pagination.rb', line 341

def to_param #:nodoc:
  @number.to_s
end

#to_sql ⇒ Object

Returns the limit/offset array for this page.



337
338
339
 
# File 'lib/action_controller/pagination.rb', line 337

def to_sql
  [@paginator.items_per_page, offset]
end

#window(padding = 2) ⇒ Object

Returns a new Window object for this page with the specified padding.



332
333
334
 
# File 'lib/action_controller/pagination.rb', line 332

def window(padding=2)
  Window.new(self, padding)
end