Class: WillPaginate::LinkRenderer

Inherits:
Object
  • Object
show all
Defined in:
lib/will_paginate/view_helpers.rb

Overview

This class does the heavy lifting of actually building the pagination links. It is used by the will_paginate helper internally.

Direct Known Subclasses

SemanticLinkRenderer

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ LinkRenderer

Returns a new instance of LinkRenderer.



220
221
222
 
# File 'lib/will_paginate/view_helpers.rb', line 220

def initialize
  @gap_marker = '<span class="gap">&hellip;</span>'
end

Instance Attribute Details

#gap_marker ⇒ Object

The gap in page links is represented by:

…



218
219
220
 
# File 'lib/will_paginate/view_helpers.rb', line 218

def gap_marker
  @gap_marker
end

Instance Method Details

#html_attributes ⇒ Object

Returns the subset of options this instance was initialized with that represent HTML attributes for the container element of pagination links.



253
254
255
256
257
258
259
260
261
 
# File 'lib/will_paginate/view_helpers.rb', line 253

def html_attributes
  return @html_attributes if @html_attributes
  @html_attributes = @options.except *(WillPaginate::ViewHelpers.pagination_options.keys - [:class])
  # pagination of Post models will have the ID of "posts_pagination"
  if @options[:container] and @options[:id] === true
    @html_attributes[:id] = @collection.first.class.name.underscore.pluralize + '_pagination'
  end
  @html_attributes
end

#prepare(collection, options, template) ⇒ Object

  • collection is a WillPaginate::Collection instance or any other object that conforms to that API

  • options are forwarded from will_paginate view helper

  • template is the reference to the template being rendered



228
229
230
231
232
233
234
235
 
# File 'lib/will_paginate/view_helpers.rb', line 228

def prepare(collection, options, template)
  @collection = collection
  @options    = options
  @template   = template

  # reset values in case we're re-using this instance
  @total_pages = @param_name = @url_string = nil
end

#to_html ⇒ Object

Process it! This method returns the complete HTML string which contains pagination links. Feel free to subclass LinkRenderer and change this method as you see fit.



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/will_paginate/view_helpers.rb', line 240

def to_html
  links = @options[:page_links] ? windowed_links : []
  # previous/next buttons
  links.unshift page_link_or_span(@collection.previous_page, 'disabled prev_page', @options[:previous_label])
  links.push    page_link_or_span(@collection.next_page,     'disabled next_page', @options[:next_label])

  html = links.join(@options[:separator])
  container_tag = @options[:semantic] ? @options[:semantic_container] : :div
  @options[:container] ? @template.content_tag(container_tag, html, html_attributes) : html
end