view release on metacpan or  search on metacpan

doc/html/Grid.html  view on Meta::CPAN

</li>
<li><a name="item_dto__i__JSON_Object___i_"></a><b>dto <i>(JSON Object)</i></b>
<p>Data transfer Object to the AJAX request. <code>Ex: {param1: 'value1', param2: 'value2'}</code></p>
<p>optional - defaulted to <code>{VUE: 'JSON'}</code></p>
</li>
<li><a name="item_method__i__String___i_"></a><b>method <i>(String)</i></b>
<p>HTTP method to open in the AJAX request.</p>
<p>optional - defaulted to <code>'post'</code></p>
</li>
<li><a name="item_columns__i__Array___i_"></a><b>columns <i>(Array)</i></b>
<p>Array of objects that defines the grid columns.</p>
<p>Ex column object:</p>
<pre>    {
        label: 'Gender',  
        value: 'gender', 
        css: 'tcenter', 
        default_value: 'unknown'
    }</pre>

<ul>
<li><a name="item_label__i__string___i_"></a><b>label <i>(string)</i></b>
<p>column label. can be an empty string</p>
<p>mandatory.</p>
</li>
<li><a name="item_value__i__string_Function___i_"></a><b>value <i>(string|Function)</i></b>
<p>string representing the key of the json element that the column is bound to.</p>
<p>Function that takes the records as an argument and returns string value of the column.
Ex: <code>value: function(e) {return e.fname + ' ' + e.lname}</code></p>
<p>mandatory.</p>
</li>
<li><a name="item_default_value__i__string___i_"></a><b>default_value <i>(string)</i></b>
<p>string value representing the column's default value if no value was found in the JSON datasource.</p>
<p>optional.</p>
</li>
<li><a name="item_css__i__string_Array___i_"></a><b>css <i>(string|Array)</i></b>
<p>a single css class or and array of css classes to be given to the column header/cells.</p>
<p>optional.</p>
</li>
</ul>
</li>
<li><a name="item_actions__i__Array___i_"></a><b>actions <i>(Array)</i></b>
<p>Array that defines the grids list of actions (to be rendered in the grid's tool bar).</p>
<p>Action object here is identical to GvaScript.CustomButtons.Button.options</p>
</li>
<li><a name="item_grabfocus__i__boolean___i_"></a><b>grabfocus <i>(boolean)</i></b>
<p>boolean indicating whether the grid container is to grab focus right after the grid has been initialized.</p>
<p>optional - defaulted to <code>true</code></p>
</li>
<li><a name="item_pagesize__i__numeric__auto____i_"></a><b>pagesize <i>(numeric|'auto')</i></b>
<p>a numeric specifying number of records to show on a page. To keep this number variable and dependant on grid's container available space, set it to 'auto'.</p>
<p>optional - defaulted to <code>'auto'</code></p>
</li>
<li><a name="item_gridheight__i__numeric__auto____i_"></a><b>gridheight <i>(numeric|'auto')</i></b>
<p>height to set to the grid. To keep this number variable and dependant on the grid's container available space, set it to 'auto'.</p>
<p>optional - defaulted to <code>'auto'</code></p>
</li>
<li><a name="item_recordheight__i__numeric___i_"></a><b>recordheight <i>(numeric)</i></b>
<p>height to set to the grid record.</p>
<p>optional - defaulted to <code>21</code></p>
</li>
<li><a name="item_requestTimeout__i__numeric___i_"></a><b>requestTimeout <i>(numeric)</i></b>
<p>time in seconds to wait before aborting the AJAX request.</p>
<p>optional - defaulted to 15</p>
</li>
<li><a name="item_errorMsg__i__string___i_"></a><b>errorMsg <i>(string)</i></b>
<p>message to display in the grid container area when the request times out.</p>
<p>optional - defaulted to "Probl&#xe8;me de connexion. R&#xe9;essayer et si le probl&#xe8;me persiste, contacter un administrateur.".</p>
</li>
</ul>

    </div>
  </div>

    </div>
  </div>
  <div class="TN_node" id="PROPERTIES">
    <h2 class="TN_label">PROPERTIES</h2>
    <div class="TN_content">
      <p>Here's a list of useful properties of the Grid Object.</p>
  <div class="TN_node" id="grid_container">
    <h3 class="TN_label">grid_container</h3>
    <div class="TN_content">
      <pre>  grid.grid_container</pre>

<p><code>HTMLElement</code> container of the grid list</p>

    </div>
  </div>
  <div class="TN_node" id="toolbar_container">
    <h3 class="TN_label">toolbar_container</h3>
    <div class="TN_content">
      <pre>  grid.toolbar_container</pre>

<p><code>HTMLElement</code> container of the toolbar (pagination links + action buttons)</p>

    </div>
  </div>
  <div class="TN_node" id="paginatorbar_container">
    <h3 class="TN_label">paginatorbar_container</h3>
    <div class="TN_content">
      <pre>  grid.paginatorbar_container</pre>

<p><code>HTMLElement</code> container of the pagination links</p>

    </div>
  </div>
  <div class="TN_node" id="actionsbar_container">
    <h3 class="TN_label">actionsbar_container</h3>
    <div class="TN_content">
      <pre> grid.actionsbar_container</pre>

<p><code>HTMLElement</code> container of the action buttons</p>

    </div>
  </div>

    </div>
  </div>
  <div class="TN_node" id="METHODS">
    <h2 class="TN_label">METHODS</h2>
    <div class="TN_content">