Class Index | File Index

Classes


Class SweetDevRia.List


Extends RiaComponent, RiaComponent.

Defined in: List.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
This is the List component class
Field Summary
Field Attributes Field Name and Description
<static>  
SweetDevRia.List.ADD_EVENT
This event type is fired when add a list item
<static>  
SweetDevRia.List.DELETE_EVENT
This event type is fired when delete a list item
<static>  
SweetDevRia.List.INSERT_EVENT
This event type is fired when insert a list item
<static>  
SweetDevRia.List.MODIFY_EVENT
This event type is fired when modify a list item
<static>  
SweetDevRia.List.MOVE_EVENT
This event type is fired when move a list item
<static>  
SweetDevRia.List.RESIZE_EVENT
This event type is fired when resize the list component
 
\ Hack pour que le premier element de la liste applique le style :hover les autres l'applique bien et le background apparait grave au background-color:white; de ideo-lst-item
Method Summary
Method Attributes Method Name and Description
<private>  
Add action, call the addData method after have get new value inside form data
<private>  
Action to open the window for add item.
<private>  
addItems(data)
Set the data into the list component
 
This method is called after Delete a data.
 
afterInsertData(data, index)
This method is called after Insert a new list item.
 
afterModifyData(index, data)
This method is called after Modify a list item value.
 
afterSetSize(width, height)
This method is called after set size.
 
This method is called before Delete a data.
 
beforeInsertData(data, index)
This method is called before Insert a new list item.
 
beforeModifyData(index, data)
This method is called before Modify a list item value.
 
beforeSetSize(width, height)
This method is called before set size.
<private>  
Close the window containing input form
<private>  
createItem(data)
<private>  
Create the pagination bar.
 
deleteData(index)
Delete a data
<private>  
deleteItem(itemIndex)
Action to delete an item.
 
formatData(data)
Default format method To be overridden !!
<private>  
Generate the list context menu that allow to the user to add, delete or modify items.
<private>  
generateWindow(width, height)
Generate the window containing input form.
<private>  
Return the render of the list
 
goToPage(actualPage)
Change the displayed page into table pagination
<private>  
This method is automatically called at the page load
 
insertData(data, index)
Insert a new list item
 
modifyData(index, data)
Modify a list item value
<private>  
Modify action, call the modifyData method after have get modified value inside form data
<private>  
modifyItem(itemIndex)
Action to open the window for modify.
<private>  
Move window at the initialize
<private>  
onPagin(evt)
This method is called on server pagination callback
<private>  
Open the window containing input form
<private>  
Reset form data
<private>  
Reset the mandatories displayed error applied to this component's windows form
<private>  
This method is called before the list resizer drag
<private>  
This method is called at the list resizer drop
<private>  
setList(data)
Set the data into the list component
 
setSize(width, height)
Modify the list size
 
Updates the server model.
Class Detail
SweetDevRia.List(id)
This is the List component class
Parameters:
{String} id
Id of this list
Field Detail
<static> SweetDevRia.List.ADD_EVENT
This event type is fired when add a list item

<static> SweetDevRia.List.DELETE_EVENT
This event type is fired when delete a list item

<static> SweetDevRia.List.INSERT_EVENT
This event type is fired when insert a list item

<static> SweetDevRia.List.MODIFY_EVENT
This event type is fired when modify a list item

<static> SweetDevRia.List.MOVE_EVENT
This event type is fired when move a list item

<static> SweetDevRia.List.RESIZE_EVENT
This event type is fired when resize the list component

template
\ Hack pour que le premier element de la liste applique le style :hover les autres l'applique bien et le background apparait grave au background-color:white; de ideo-lst-item
Method Detail
<private> addDataAction(evt)
Add action, call the addData method after have get new value inside form data
Parameters:
evt

<private> addItem()
Action to open the window for add item. Reset the window form.

<private> addItems(data)
Set the data into the list component
Parameters:
{Array} data
the array of bean to set.

afterDeleteData(index)
This method is called after Delete a data. To be overridden !!
Parameters:
{int} index
Data index to delete

afterInsertData(data, index)
This method is called after Insert a new list item. To be overridden !!
Parameters:
{Object} data
The new data value
index

afterModifyData(index, data)
This method is called after Modify a list item value. To be overridden !!
Parameters:
{int} index
Index of item to modify
{Object} data
The new data value

afterSetSize(width, height)
This method is called after set size. To be overridden !!
Parameters:
{int} width
The new list width
{int} height
The new list height

{boolean} beforeDeleteData(index)
This method is called before Delete a data. To be overridden !!
Parameters:
{int} index
Data index to delete
Returns:
True if this method can be called, else false.

{boolean} beforeInsertData(data, index)
This method is called before Insert a new list item. To be overridden !!
Parameters:
{Object} data
The new data value
index
Returns:
True if this method can be called, else false.

{boolean} beforeModifyData(index, data)
This method is called before Modify a list item value. To be overridden !!
Parameters:
{int} index
Index of item to modify
{Object} data
The new data value
Returns:
True if this method can be called, else false.

{boolean} beforeSetSize(width, height)
This method is called before set size. To be overridden !!
Parameters:
{int} width
The new list width
{int} height
The new list height
Returns:
True if this method can be called, else false.

<private> closeWindow(evt)
Close the window containing input form
Parameters:
{Event} evt
Mouse event

<private> createItem(data)
Parameters:
data

<private> createPageBar()
Create the pagination bar.

deleteData(index)
Delete a data
Parameters:
{int} index
Data index to delete

<private> deleteItem(itemIndex)
Action to delete an item.
Parameters:
{int} itemIndex
Index of the item to delete

{String} formatData(data)
Default format method To be overridden !!
Parameters:
{Object} data
Data to format for list display
Returns:
the formatted data to display in the list

<private> generateMenu()
Generate the list context menu that allow to the user to add, delete or modify items.

<private> generateWindow(width, height)
Generate the window containing input form.
Parameters:
{int} width
Window width
{int} height
Window height

<private> {String} getListRender(width)
Return the render of the list
Parameters:
{int} width
The new list width
Returns:
the DOM String representing the list

goToPage(actualPage)
Change the displayed page into table pagination
Parameters:
{int} actualPage
New displayed page number
See:
SweetDevRia.PageBar.prototype.goToPage

<private> initialize()
This method is automatically called at the page load

insertData(data, index)
Insert a new list item
Parameters:
{Object} data
The new data value
{int} index
The new data index

modifyData(index, data)
Modify a list item value
Parameters:
{int} index
Index of item to modify
{Object} data
The new data value

<private> modifyDataAction(evt)
Modify action, call the modifyData method after have get modified value inside form data
Parameters:
evt

<private> modifyItem(itemIndex)
Action to open the window for modify. Set the window form with the data to modify.
Parameters:
{int} itemIndex
Index of the item to modify

<private> moveWindow()
Move window at the initialize

<private> onPagin(evt)
This method is called on server pagination callback
Parameters:
{RiaEvent} evt
Event containing data to displayed

<private> openWindow()
Open the window containing input form

<private> resetForm()
Reset form data

<private> resetMandatoryErrors()
Reset the mandatories displayed error applied to this component's windows form

<private> resizerOnMouseDown(list)
This method is called before the list resizer drag
Parameters:
{list} list
list component associated wit this resizer

<private> resizerOnMouseUp(list)
This method is called at the list resizer drop
Parameters:
{list} list
list component associated wit this resizer

<private> setList(data)
Set the data into the list component
Parameters:
{Array} data
the array of bean to set.

setSize(width, height)
Modify the list size
Parameters:
{int} width
The new list width (null to keep the previous value)
{int} height
The new list height (null to keep the previous value)

updateServerModel()
Updates the server model.

Documentation generated by JsDoc Toolkit 2.0.0 on Thu May 05 2011 12:20:31 GMT+0200 (CEST)