Class: Datagrid::Columns::Column

Inherits:
Object
  • Object
show all
Defined in:
lib/datagrid/columns/column.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(grid, name, options = {}, &block) ⇒ Column

Returns a new instance of Column.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/datagrid/columns/column.rb', line 5

def initialize(grid, name, options = {}, &block)
  self.grid = grid
  self.name = name.to_sym
  self.options = options
  if options[:html] == true
    self.html_block = block
  else
    if options[:html].is_a? Proc
      self.html_block = options[:html]
    end
    self.block = block
  end
  if format
    ::Datagrid::Utils.warn_once(":format column option is deprecated. Use :url or :html option instead.")
  end
end

Instance Attribute Details

#block ⇒ Object

Returns the value of attribute block.



3
4
5
 
# File 'lib/datagrid/columns/column.rb', line 3

def block
  @block
end

#grid ⇒ Object

Returns the value of attribute grid.



3
4
5
 
# File 'lib/datagrid/columns/column.rb', line 3

def grid
  @grid
end

#html_block ⇒ Object

Returns the value of attribute html_block.



3
4
5
 
# File 'lib/datagrid/columns/column.rb', line 3

def html_block
  @html_block
end

#name ⇒ Object

Returns the value of attribute name.



3
4
5
 
# File 'lib/datagrid/columns/column.rb', line 3

def name
  @name
end

#options ⇒ Object

Returns the value of attribute options.



3
4
5
 
# File 'lib/datagrid/columns/column.rb', line 3

def options
  @options
end

Instance Method Details

#data? ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/datagrid/columns/column.rb', line 66

def data?
  self.block != nil
end

#format ⇒ Object 



36
37
38
 
# File 'lib/datagrid/columns/column.rb', line 36

def format
  self.options[:format]
end

#header ⇒ Object 



44
45
46
47
 
# File 'lib/datagrid/columns/column.rb', line 44

def header
  self.options[:header] || 
    I18n.translate(self.name, :scope => "datagrid.#{self.grid.param_name}.columns", :default => self.name.to_s.humanize )
end

#html? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/datagrid/columns/column.rb', line 62

def html?
  self.html_block != nil
end

#label ⇒ Object 



40
41
42
 
# File 'lib/datagrid/columns/column.rb', line 40

def label
  self.options[:label]
end

#order ⇒ Object 



49
50
51
52
53
54
55
 
# File 'lib/datagrid/columns/column.rb', line 49

def order
  if options.has_key?(:order)
    self.options[:order]
  else
    grid.driver.default_order(grid.scope, name)
  end
end

#order_desc ⇒ Object 



57
58
59
60
 
# File 'lib/datagrid/columns/column.rb', line 57

def order_desc
  return nil unless order
  self.options[:order_desc]  
end

#value(model, grid) ⇒ Object 



22
23
24
 
# File 'lib/datagrid/columns/column.rb', line 22

def value(model, grid)
  value_for(model, grid)
end

#value_for(model, grid) ⇒ Object 



26
27
28
29
30
31
32
33
34
 
# File 'lib/datagrid/columns/column.rb', line 26

def value_for(model, grid)
  if self.block.arity == 1
    self.block.call(model)
  elsif self.block.arity == 2
    self.block.call(model, grid)
  else
    model.instance_eval(&self.block)
  end
end