Class f_grid

Object
  extended by f_object
      extended by f_eventTarget
          extended by f_component
              extended by f_grid
All Implemented Interfaces:
Element, fa_additionalInformationManager, fa_aria, fa_autoScroll, fa_cardinality, fa_clientData, fa_clientFullState, fa_commands, fa_disabled, fa_draggable, fa_droppable, fa_eventTarget, fa_filterProperties, fa_immediate, fa_itemsManager, fa_pagedComponent, fa_scrollPositions, fa_selectionManager, fa_selectionProvider, fa_serializable, fa_subMenu, HTMLElement, Node
Direct Known Subclasses:
f_componentsGrid, f_dataGrid

public abstract class f_grid
extends f_component
implements fa_subMenu, fa_scrollPositions, fa_disabled, fa_aria, fa_additionalInformationManager, fa_immediate, fa_autoScroll, fa_droppable, fa_commands, fa_selectionManager, fa_draggable, fa_pagedComponent


Field Summary
 
Fields inherited from class fa_selectionManager
BEGIN_PHASE, END_PHASE
 
Fields inherited from class fa_cardinality
ONEMANY_CARDINALITY, ONE_CARDINALITY, OPTIONAL_CARDINALITY, ZEROMANY_CARDINALITY
 
Fields inherited from class fa_clientFullState
NONE_CLIENT_FULL_STATE, ONEWAY_CLIENT_FULL_STATE, TWOWAYS_CLIENT_FULL_STATE
 
Fields inherited from class f_component
DEFAULT_HIDDEN_MODE, HIDDEN_MODE_IGNORE, HIDDEN_MODE_PHANTOM, HIDDEN_MODE_SERVER
 
Fields inherited from class HTMLElement
className, dir, id, lang
 
Fields inherited from class Element
tagName
 
Fields inherited from class Node
childNodes, firstChild, lastChild, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, previousSibling
 
Method Summary
static f_grid GetGridFromComponent(f_component component)
          Return the current ComponetGrid
static void RegisterSortManager(String name, Function callback)
           
 Number f_clear(any... rowValue1)
           
 Number f_clearAll()
           
 Number f_clearArray(any[] rowValues)
           
 void f_clearSort()
          Clean the sort
 void f_collapseAllAdditionalInformations()
           
 String f_computeEventColumnId(f_event event)
           
 boolean f_deselectRow(any rowValue, boolean show)
          Deselect a row
 void f_expandAllAdditionalInformations()
           
 String f_getColumnId(f_gridColumn column)
          Returns the id associated to the column.
 String f_getColumnName(f_gridColumn column)
          Returns the name associated to the column.
 Number f_getColumnOrderState(f_gridColumn column)
          Deprecated.  
 f_gridColumn[] f_getColumns()
          List the columns of the grid
 Number f_getDragEffects(any selection)
           
 Array f_getDragItems(any selection)
           
 Array f_getDragItemsElement(any selection)
           
 Array f_getDragItemsValue(any selection)
           
 Array f_getDragTypes(any selection)
           
 String f_getEmptyDataMessage()
           
 Object f_getRowByValue(any value)
          Returns the row associated to a value.
 String f_getRowValue(any rowObject)
          Returns the value of the row.
 String f_getRowValueAtIndex(any rowIndex)
          Returns the value of the row specified by its index.
 Object f_getRowValueFromCommponent(f_component component)
          Return the value of the row which contains the specified component.
 f_gridColumn[] f_getSortedColumns()
          gives the ordered set of sorted columns
 boolean f_hasElementAdditionalInformation(any rowValue)
           
 boolean f_isRefreshFullUpdateState()
          Get the refreshFullUpdateState that force the refresh to be full
 boolean f_isRowSelected(Object row)
           
 boolean f_isSelected(any rowValue)
          Returns true if the receiver is checked, and false otherwise
 boolean f_refreshContent(boolean fullUpdate)
          Refresh the structure of the grid.
 void f_selectAllPage()
          select all rows in the current page
 boolean f_selectRow(any rowValue, boolean append, boolean show)
          Select a row
 void f_setColumnSort(f_gridColumn col, boolean ascending, boolean append, f_gridColumn col2, boolean ascending2)
           
 void f_setEmptyDataMessage(String message)
           
 boolean f_setFirst(Number index, Number cursorIndex)
          Specify the index of the first row which starts the grid.
 void f_setHeight(Number height)
          Set the height of the component.
 void f_setRefreshFullUpdateState(boolean fullUpdate)
          Set the refreshFullUpdateState that force the refresh to be full
 void f_setWidth(Number width)
          Set the width of the component
 boolean f_showRow(any rowValue)
          Show a row.
 void f_unselectAll()
          unSelect all rows in the current page
 
Methods inherited from class fa_subMenu
f_getSubMenuById, f_listSubMenus
 
Methods inherited from class fa_scrollPositions
f_getHorizontalScrollPosition, f_getVerticalScrollPosition, f_setHorizontalScrollPosition, f_setVerticalScrollPosition
 
Methods inherited from class fa_disabled
f_isDisabled, f_setDisabled
 
Methods inherited from class fa_additionalInformationManager
f_expandAdditionalInformations, f_getAdditionalInformationValues
 
Methods inherited from class fa_immediate
f_isImmediate
 
Methods inherited from class fa_droppable
f_isDroppable, f_outDropInfos, f_overDropInfos, f_queryDropInfos, f_releaseDropInfos
 
Methods inherited from class fa_selectionManager
f_getSelection, f_setSelection
 
Methods inherited from class fa_selectionProvider
f_getSelection, f_setSelection
 
Methods inherited from class fa_draggable
f_getDragEffects, f_getDragItems, f_getDragItemsElement, f_getDragItemsValue, f_getDragTypes, f_isDraggable
 
Methods inherited from class fa_pagedComponent
f_getFirst, f_getMaxRows, f_getRowCount, f_getRows, f_isPaged
 
Methods inherited from class fa_filterProperties
f_getFilterProperties, f_setFilterProperties, f_setFilterProperty
 
Methods inherited from class f_component
f_findComponent, f_findSiblingComponent, f_getAccessKey, f_getBackgroundColor, f_getDocument, f_getForegroundColor, f_getHeight, f_getHelpMessage, f_getHelpURL, f_getHiddenMode, f_getId, f_getParent, f_getToolTipText, f_getVisible, f_getWidth, f_getX, f_getY, f_isVisible, f_setBackgroundColor, f_setFocus, f_setForegroundColor, f_setHeight, f_setHelpMessage, f_setHelpURL, f_setHiddenMode, f_setToolTipText, f_setVisible, f_setWidth, f_setX, f_setY, f_show, toString
 
Methods inherited from class fa_clientData
f_getClientData, f_getClientDataSet, f_getClientDatas, f_setClientData
 
Methods inherited from class fa_eventTarget
f_addEventListener, f_fireEvent, f_removeEventListener
 
Methods inherited from class Element
getAttribute, getElementsByTagName, removeAttribute, setAttribute
 
Methods inherited from class Node
appendChild, hasChildNodes, insertBefore, removeChild, replaceChild
 
Methods inherited from class f_object
f_getClass, toString
 
Methods inherited from class Object
toString
 

Method Detail

f_getDragEffects

public Number f_getDragEffects(any selection)

f_setHeight

public void f_setHeight(Number height)
Set the height of the component.

Overrides:
f_setHeight in class f_component
Parameters:
height - Height of the component.

f_getDragItems

public Array f_getDragItems(any selection)

f_selectRow

public boolean f_selectRow(any rowValue,
                           boolean append,
                           boolean show)
Select a row

Parameters:
rowValue - Value associated to the row
append - Inclusive or Exclusive selection
show - Show the selected row.
Returns:
Returns true if success.

f_getRowValueFromCommponent

public Object f_getRowValueFromCommponent(f_component component)
Return the value of the row which contains the specified component.

Parameters:
component - Component or HTMLElement
Returns:
Value of the row

f_getEmptyDataMessage

public String f_getEmptyDataMessage()

f_expandAllAdditionalInformations

public void f_expandAllAdditionalInformations()

f_computeEventColumnId

public String f_computeEventColumnId(f_event event)
Parameters:
event -
Returns:
Identifier of column or null if not found.

f_isRefreshFullUpdateState

public boolean f_isRefreshFullUpdateState()
Get the refreshFullUpdateState that force the refresh to be full


f_clearArray

public Number f_clearArray(any[] rowValues)
Parameters:
rowValues - List of values whose specified rows.
Returns:
Number of removed rows.

f_getRowValue

public String f_getRowValue(any rowObject)
Returns the value of the row.

Parameters:
rowObject - Row object.
Returns:
the key of the row.

f_getColumnName

public String f_getColumnName(f_gridColumn column)
Returns the name associated to the column.

Parameters:
column - The column object
Returns:
The name of the column.

f_getColumns

public f_gridColumn[] f_getColumns()
List the columns of the grid

Returns:
An array of column object.

f_getColumnId

public String f_getColumnId(f_gridColumn column)
Returns the id associated to the column.

Parameters:
column - The column object
Returns:
The Id of the column.

f_setWidth

public void f_setWidth(Number width)
Set the width of the component

Overrides:
f_setWidth in class f_component
Parameters:
width - Width of the component.

f_isSelected

public boolean f_isSelected(any rowValue)
Returns true if the receiver is checked, and false otherwise

Parameters:
rowValue - Value associated to the row, or a row object.
Returns:
The checked state of the row

f_getRowValueAtIndex

public String f_getRowValueAtIndex(any rowIndex)
Returns the value of the row specified by its index.

Parameters:
rowIndex - Row object.
Returns:
the key of the row.

f_unselectAll

public void f_unselectAll()
unSelect all rows in the current page


f_selectAllPage

public void f_selectAllPage()
select all rows in the current page


GetGridFromComponent

public static f_grid GetGridFromComponent(f_component component)
Return the current ComponetGrid

Parameters:
component -

f_getDragItemsElement

public Array f_getDragItemsElement(any selection)

f_collapseAllAdditionalInformations

public void f_collapseAllAdditionalInformations()

f_getRowByValue

public Object f_getRowByValue(any value)
Returns the row associated to a value.

Parameters:
value - Value of the row, or a row object.
Returns:
row associated or null.

f_showRow

public boolean f_showRow(any rowValue)
Show a row.

Parameters:
rowValue - Value associated to the row
Returns:
Return true if the row associated to the rowValue is found.

f_clearAll

public Number f_clearAll()
Returns:
Number of removed rows.

f_isRowSelected

public boolean f_isRowSelected(Object row)
Parameters:
row -

f_setEmptyDataMessage

public void f_setEmptyDataMessage(String message)
Parameters:
message -

f_refreshContent

public boolean f_refreshContent(boolean fullUpdate)
Refresh the structure of the grid.

Parameters:
fullUpdate - to force rowCount and pager update

f_hasElementAdditionalInformation

public boolean f_hasElementAdditionalInformation(any rowValue)

f_clearSort

public void f_clearSort()
Clean the sort


f_setFirst

public boolean f_setFirst(Number index,
                          Number cursorIndex)
Specify the index of the first row which starts the grid.

Parameters:
index -
cursorIndex - The cursor index. (can be undefined)
Returns:
Returns false.

f_setColumnSort

public void f_setColumnSort(f_gridColumn col,
                            boolean ascending,
                            boolean append,
                            f_gridColumn col2,
                            boolean ascending2)
Parameters:
col - Column to sort
ascending - Sort ascending.
append - Append the sort.
col2 - Column 2
ascending2 - Sort ascending2.

f_getColumnOrderState

public Number f_getColumnOrderState(f_gridColumn column)
Deprecated. 

Parameters:
column -
Returns:
Ascending:1 Descending:-1 not-sorted:0

f_setRefreshFullUpdateState

public void f_setRefreshFullUpdateState(boolean fullUpdate)
Set the refreshFullUpdateState that force the refresh to be full

Parameters:
fullUpdate - to force rowCount and pager update

f_getDragItemsValue

public Array f_getDragItemsValue(any selection)

f_clear

public abstract Number f_clear(any... rowValue1)
Parameters:
rowValue1 - The value of the row to remove
Returns:
Number of removed rows.

RegisterSortManager

public static void RegisterSortManager(String name,
                                       Function callback)
Parameters:
name -
callback -

f_getDragTypes

public Array f_getDragTypes(any selection)

f_deselectRow

public boolean f_deselectRow(any rowValue,
                             boolean show)
Deselect a row

Parameters:
rowValue - Value associated to the row
show - Show the deselected row.
Returns:
Returns true if success.

f_getSortedColumns

public f_gridColumn[] f_getSortedColumns()
gives the ordered set of sorted columns