telosys.functions
Interface ListWidget

public interface ListWidget

Set of functions for "list" widget management Usefull for the tags "list", "listhead", "listbody" and "listrow" ( see the TagLib )

Method Summary
 void fwkAdjustHeadWidth(string sIdHead, string sIdBody)
          Internal framework function Automatically called by the widget to adjust the width of the list head
 number fwkListGetRowCount(object obj)
          Returns the number of rows
 number fwkListGetRowCount(string id)
          Returns the number of rows
 object fwkListGetRows(object obj, string sFctArg)
          Returns all rows of the list
 object fwkListGetRows(string id, string sFctArg)
          Returns all rows of the list
 object fwkListGetSelectedRow(object obj, string sFctArg)
          Returns the selected row of the list
 object fwkListGetSelectedRow(string id, string sFctArg)
          Returns the selected row of the list
 object fwkListGetTBody(object obj, string sFctArg)
          Returns the TBODY of the list widget
 object fwkListGetTBody(string id, string sFctArg)
          Returns the TBODY of the given list widget id
 void fwkListRowMouseOut(object oTR)
          Internal framework function Function called by the 'onmouseout' event
 void fwkListRowMouseOver(object oTR)
          Internal framework function Function called by the 'onmouseover' event
 void fwkListRowSelect(object oTR)
          Internal framework function Function called by the framework to select a row
 void fwkListRowUnSelect(object oTR)
          Internal framework function Function called by the framework to unselect a row
 void fwkListSelect(object obj, number index)
          Selects the row of the list associated with the given index
 void fwkListSelect(string id, number index)
          Selects the row of the list associated with the given index
 void fwkListSelectFirst(object obj)
          Selects the first row of the list
 void fwkListSelectFirst(string id)
          Selects the first row of the list
 void fwkListSelectLast(object obj)
          Selects the last row of the list
 void fwkListSelectLast(string id)
          Selects the last row of the list
 void fwkListSelectNext(object obj)
          Selects the next row of the list
 void fwkListSelectNext(string id)
          Selects the next row of the list
 void fwkListSelectPrev(object obj)
          Selects the previous row of the list
 void fwkListSelectPrev(string id)
          Selects the previous row of the list
 void fwkListUnSelect(object obj)
          Unselect the selected row if any
 void fwkListUnSelect(string id)
          Unselect the selected row if any
 void fwkScrollHead(string sIdHead, object oBody)
          Internal framework function Function called by the 'onscroll' event to force the list head to follow the list body horizontal position
 

Method Detail

fwkListGetTBody

public object fwkListGetTBody(object obj,
                              string sFctArg)
Returns the TBODY of the list widget

Parameters:
obj - : the list body DIV object
sFctArg - : caller function name
Returns:
the TBODY object

fwkListGetTBody

public object fwkListGetTBody(string id,
                              string sFctArg)
Returns the TBODY of the given list widget id

Parameters:
id - : the id of the list body DIV element
sFctArg - : caller function name
Returns:
the TBODY object

fwkListGetRowCount

public number fwkListGetRowCount(object obj)
Returns the number of rows

Parameters:
obj - the list reference
Returns:
the number of rows

fwkListGetRowCount

public number fwkListGetRowCount(string id)
Returns the number of rows

Parameters:
id - : the id of the list body DIV element
Returns:
the number of rows

fwkListGetRows

public object fwkListGetRows(object obj,
                             string sFctArg)
Returns all rows of the list

Parameters:
obj - the list reference
sFctArg - : caller function name ( or null )
Returns:
all the rows of the list ( the TBODY 'rows' attribute : array of 'TR' objects )

fwkListGetRows

public object fwkListGetRows(string id,
                             string sFctArg)
Returns all rows of the list

Parameters:
id - : the id of the list body DIV element
sFctArg - : caller function name ( or null )
Returns:
all the rows of the list ( the TBODY 'rows' attribute : array of 'TR' objects )

fwkListGetSelectedRow

public object fwkListGetSelectedRow(object obj,
                                    string sFctArg)
Returns the selected row of the list

Parameters:
obj - the list reference
sFctArg - : caller function name or null
Returns:
the selected row of the list

fwkListGetSelectedRow

public object fwkListGetSelectedRow(string id,
                                    string sFctArg)
Returns the selected row of the list

Parameters:
id - : the id of the list body DIV element
sFctArg - : caller function name or null
Returns:
the selected row of the list

fwkListSelect

public void fwkListSelect(object obj,
                          number index)
Selects the row of the list associated with the given index

Parameters:
obj - the list reference
index - the row index

fwkListSelect

public void fwkListSelect(string id,
                          number index)
Selects the row of the list associated with the given index

Parameters:
id - : the id of the list body DIV element
index - the row index

fwkListSelectFirst

public void fwkListSelectFirst(object obj)
Selects the first row of the list

Parameters:
obj - the list reference

fwkListSelectFirst

public void fwkListSelectFirst(string id)
Selects the first row of the list

Parameters:
id - : the id of the list body DIV element

fwkListSelectLast

public void fwkListSelectLast(object obj)
Selects the last row of the list

Parameters:
obj - the list reference

fwkListSelectLast

public void fwkListSelectLast(string id)
Selects the last row of the list

Parameters:
id - : the id of the list body DIV element

fwkListSelectNext

public void fwkListSelectNext(object obj)
Selects the next row of the list

Parameters:
obj - the list reference

fwkListSelectNext

public void fwkListSelectNext(string id)
Selects the next row of the list

Parameters:
id - : the id of the list body DIV element

fwkListSelectPrev

public void fwkListSelectPrev(object obj)
Selects the previous row of the list

Parameters:
obj - the list reference

fwkListSelectPrev

public void fwkListSelectPrev(string id)
Selects the previous row of the list

Parameters:
id - : the id of the list body DIV element

fwkListUnSelect

public void fwkListUnSelect(object obj)
Unselect the selected row if any

Parameters:
obj - the list reference

fwkListUnSelect

public void fwkListUnSelect(string id)
Unselect the selected row if any

Parameters:
id - : the id of the list body DIV element

fwkListRowUnSelect

public void fwkListRowUnSelect(object oTR)
Internal framework function Function called by the framework to unselect a row

Parameters:
oTR - the row element reference ( the 'TR' object )

fwkListRowSelect

public void fwkListRowSelect(object oTR)
Internal framework function Function called by the framework to select a row

Parameters:
oTR - the row element reference ( the 'TR' object )

fwkListRowMouseOver

public void fwkListRowMouseOver(object oTR)
Internal framework function Function called by the 'onmouseover' event

Parameters:
oTR - the row element reference ( the 'TR' object )

fwkListRowMouseOut

public void fwkListRowMouseOut(object oTR)
Internal framework function Function called by the 'onmouseout' event

Parameters:
oTR - the row element reference ( the 'TR' object )

fwkAdjustHeadWidth

public void fwkAdjustHeadWidth(string sIdHead,
                               string sIdBody)
Internal framework function Automatically called by the widget to adjust the width of the list head

Parameters:
sIdHead - the list head id
sIdBody - the list body id

fwkScrollHead

public void fwkScrollHead(string sIdHead,
                          object oBody)
Internal framework function Function called by the 'onscroll' event to force the list head to follow the list body horizontal position

Parameters:
sIdHead - the list head id
oBody - the list body reference