Methods

Netzke::Basepack::GridPanel::Columns::ClassMethods

Public Instance Methods

meta_columns() click to toggle source

Columns to be displayed by the FieldConfigurator, “meta-columns”. Each corresponds to a configuration option for each column in the grid.

    # File lib/netzke/basepack/grid_panel/columns.rb, line 10
10:           def meta_columns
11:             [
12:               # Whether the column will be present in the grid, also in :hidden or :meta state. The value for this column will
13:               # always be sent to/from the JS grid to the server
14:               {:name => "included",      :attr_type => :boolean, :width => 40, :header => "Incl", :default_value => true},
15: 
16:               # The name of the column. May be any accessible method or attribute of the data_class.
17:               {:name => "name",          :attr_type => :string, :width => 200},
18: 
19:               # The header for the column.
20:               {:name => "label",         :attr_type => :string, :width => 200, :header => "Header"},
21: 
22:               # The default value of this column. Is used when a new row in the grid gets created.
23:               {:name => "default_value", :attr_type => :string, :width => 200},
24: 
25:               # Options for drop-downs
26:               {:name => "combobox_options",       :attr_type => :string, :editor => :textarea, :width => 200},
27: 
28:               # Whether the column is editable in the grid.
29:               {:name => "read_only",     :attr_type => :boolean, :header => "R/O", :tooltip => "Read-only"},
30: 
31:               # Whether the column will be in the hidden state (hide/show columns from the column menu, if it's enabled).
32:               {:name => "hidden",        :attr_type => :boolean},
33: 
34:               # Whether the column should have "grid filters" enabled
35:               # (see here: http://www.extjs.com/deploy/dev/examples/grid-filtering/grid-filter-local.html)
36:               {:name => "with_filters",  :attr_type => :boolean, :default_value => true, :header => "Filters"},
37: 
38:               #
39:               # Below some rarely used parameters, hidden by default (you can always un-hide them from the column menu).
40:               #
41: 
42:               # The column's width
43:               {:name => "width",         :attr_type => :integer, :hidden => true},
44: 
45:               # Whether the column should be hideable
46:               {:name => "hideable",      :attr_type => :boolean, :default_value => true, :hidden => true},
47: 
48:               # Whether the column should be sortable (why change it? normally it's hardcoded)
49:               {:name => "sortable",      :attr_type => :boolean, :default_value => true, :hidden => true},
50:             ]
51:           end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.