EventMediator (Advanced GWT Components 2.0.9 API)

java.lang.Object
- org.gwt.advanced.client.ui.widget.EventMediator

All Implemented Interfaces:

EditableModelListener, GridListener, GridToolbarListener, PagerListener, SelectRowListener
```
public class EventMediator
extends Object
implements PagerListener, GridListener, GridToolbarListener, SelectRowListener, EditableModelListener
```
This is an event mediator class developer for centralized grid panel subcomponents interoperability.

Since:

1.0.0

Author:

Sergey Skladchikov

Constructor Summary

Constructors
Constructor and Description

EventMediator(GridPanel panel)
Creates an instance of the mediator and initializes the internal fields.

Constructors
Constructor and Description
`EventMediator(GridPanel panel)` Creates an instance of the mediator and initializes the internal fields.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGridListener(GridListener listener)` This method adds a grid listener.
`void`	`addPagerListener(PagerListener listener)` This method adds a pager listener.
`void`	`addToolbarListener(GridToolbarListener listener)` This method adds a toolbar listener.
`protected void`	`fireAddRowEvent()` This method fires the add item event.
`protected void`	`fireClearEvent()` This method fires the clear items event.
`void`	`fireClearEvent(GridDataModel model)` This method fires the cleaning event.
`protected void`	`fireMoveLeftEvent()` Fires the move left click event.
`protected void`	`fireMoveRightEvent()` Fires the move right click event.
`void`	`firePageChangeEvent(Pager pager, int page)` This method fires page change event.
`protected void`	`fireRemoveRowEvent()` This method fires the remove item event.
`protected void`	`fireSaveEvent()` This method fires the save event.
`void`	`fireSaveEvent(GridDataModel model)` This method fires grid changes saving event.
`void`	`fireSortEvent(HeaderCell cell, GridDataModel model)` This method fires sorting event.
`protected List<GridListener>`	`getGridListeners()` Getter for property 'gridListeners'.
`protected List<PagerListener>`	`getPagerListeners()` Getter for property 'pagerListeners'.
`protected GridPanel`	`getPanel()` Getter for property 'panel'.
`protected List<GridToolbarListener>`	`getToolbarListeners()` Getter for property 'toolbarListeners'.
`void`	`onAddClick()` This is an operation to be done on Add button click.
`void`	`onClear(GridDataModel dataModel)` This method is invoked on grid cler operation.
`void`	`onClearClick()` This is an operation to be done on Clear button click.
`void`	`onModelEvent(EditableModelEvent event)` This method dispatches the model events and invokes appropriate methods of the related grid.
`void`	`onMoveLeftClick()` This is anoperation to be done on Move Left button click.
`void`	`onMoveRightClick()` This is anoperation to be done on Move Right button click.
`void`	`onPageChange(Pager sender, int page)` This method is invoked on page change event.
`void`	`onRemoveClick()` This is an operation to be done on Remove button click.
`void`	`onSave(GridDataModel dataModel)` This method in invoked on save opeartion.
`void`	`onSaveClick()` This is an operation to be done on Save button click.
`void`	`onSelect(EditableGrid grid, int row)` This method is invoked every time when row selection is done.
`void`	`onSort(HeaderCell cell, GridDataModel dataModel)` This method is invoked on column sort event.
`void`	`removeGridListener(GridListener listener)` This method removes a grid listener.
`void`	`removePagerListener(PagerListener listener)` This method removes a pager listener.
`void`	`removeToolbarListener(GridToolbarListener listener)` This method removes a toolbar listener.
`protected void`	`setCurrentPageNumber(GridDataModel model, Pager pager)` This method sets a curent page number.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - EventMediator
```
public EventMediator(GridPanel panel)
```
    Creates an instance of the mediator and initializes the internal fields.
    
    Parameters:
    panel - is a grid panel.
- Method Detail
  - onPageChange
```
public void onPageChange(Pager sender,
                int page)
```
    This method is invoked on page change event.
    
    Specified by:
    
    onPageChange in interface PagerListener
    
    Parameters:
    sender - is a pager that sent the event.
    page - is a new page number.
  - onSort
```
public void onSort(HeaderCell cell,
          GridDataModel dataModel)
```
    This method is invoked on column sort event.
    
    Specified by:
    
    onSort in interface GridListener
    
    Parameters:
    cell - is a header cell widget.
    dataModel - is a data model to be updated.
  - onSave
```
public void onSave(GridDataModel dataModel)
```
    This method in invoked on save opeartion.
    Listeners should persist changes because as soon as this method in invoked the change hsitory will be destroyed.
    
    Specified by:
    
    onSave in interface GridListener
    
    Parameters:
    dataModel - is a data model.
  - onClear
```
public void onClear(GridDataModel dataModel)
```
    This method is invoked on grid cler operation.
    Listeners don't have to persist changes since the history will be keeped. In case if you decide persist changes, don't forget to clear the history manually.
    
    Specified by:
    
    onClear in interface GridListener
    
    Parameters:
    dataModel - is a data model.
  - onAddClick
```
public void onAddClick()
```
    This is an operation to be done on Add button click.
    
    Specified by:
    
    onAddClick in interface GridToolbarListener
  - onRemoveClick
```
public void onRemoveClick()
```
    This is an operation to be done on Remove button click.
    
    Specified by:
    
    onRemoveClick in interface GridToolbarListener
  - onSaveClick
```
public void onSaveClick()
```
    This is an operation to be done on Save button click.
    
    Specified by:
    
    onSaveClick in interface GridToolbarListener
  - onClearClick
```
public void onClearClick()
```
    This is an operation to be done on Clear button click.
    
    Specified by:
    
    onClearClick in interface GridToolbarListener
  - onSelect
```
public void onSelect(EditableGrid grid,
            int row)
```
    This method is invoked every time when row selection is done.
    
    Specified by:
    
    onSelect in interface SelectRowListener
    
    Parameters:
    grid - is a grid where the row has been selected.
    row - is a selected row number.
  - firePageChangeEvent
```
public void firePageChangeEvent(Pager pager,
                       int page)
```
    This method fires page change event.
    
    Parameters:
    pager - is a pager which is a source of the event.
    page - is a new page number.
  - fireSaveEvent
```
public void fireSaveEvent(GridDataModel model)
```
    This method fires grid changes saving event.
    
    Parameters:
    model - is a grid data model.
  - fireSortEvent
```
public void fireSortEvent(HeaderCell cell,
                 GridDataModel model)
```
    This method fires sorting event.
    
    Parameters:
    cell - is a header cell.
    model - is a grid data model.
  - fireClearEvent
```
public void fireClearEvent(GridDataModel model)
```
    This method fires the cleaning event.
    
    Parameters:
    model - is a grid data model.
  - fireAddRowEvent
```
protected void fireAddRowEvent()
```
    This method fires the add item event.
  - fireRemoveRowEvent
```
protected void fireRemoveRowEvent()
```
    This method fires the remove item event.
  - fireSaveEvent
```
protected void fireSaveEvent()
```
    This method fires the save event.
  - fireClearEvent
```
protected void fireClearEvent()
```
    This method fires the clear items event.
  - fireMoveLeftEvent
```
protected void fireMoveLeftEvent()
```
    Fires the move left click event.
  - fireMoveRightEvent
```
protected void fireMoveRightEvent()
```
    Fires the move right click event.
  - onMoveLeftClick
```
public void onMoveLeftClick()
```
    This is anoperation to be done on Move Left button click.
    
    Specified by:
    
    onMoveLeftClick in interface GridToolbarListener
  - onMoveRightClick
```
public void onMoveRightClick()
```
    This is anoperation to be done on Move Right button click.
    
    Specified by:
    
    onMoveRightClick in interface GridToolbarListener
  - addPagerListener
```
public void addPagerListener(PagerListener listener)
```
    This method adds a pager listener.
    
    Parameters:
    listener - is a pager listener.
  - removePagerListener
```
public void removePagerListener(PagerListener listener)
```
    This method removes a pager listener.
    
    Parameters:
    listener - is a pager listener.
  - addGridListener
```
public void addGridListener(GridListener listener)
```
    This method adds a grid listener.
    
    Parameters:
    listener - is a pager listener.
  - removeGridListener
```
public void removeGridListener(GridListener listener)
```
    This method removes a grid listener.
    
    Parameters:
    listener - is a grid listener.
  - addToolbarListener
```
public void addToolbarListener(GridToolbarListener listener)
```
    This method adds a toolbar listener.
    
    Parameters:
    listener - is a toolbar listener.
  - removeToolbarListener
```
public void removeToolbarListener(GridToolbarListener listener)
```
    This method removes a toolbar listener.
    
    Parameters:
    listener - is a toolbar listener.
  - onModelEvent
```
public void onModelEvent(EditableModelEvent event)
```
    This method dispatches the model events and invokes appropriate methods of the related grid.
    
    Specified by:
    
    onModelEvent in interface EditableModelListener
    
    Parameters:
    event - is an event to be dispatched.
  - getPanel
```
protected GridPanel getPanel()
```
    Getter for property 'panel'.
    
    Returns:
    Value for property 'panel'.
  - getPagerListeners
```
protected List<PagerListener> getPagerListeners()
```
    Getter for property 'pagerListeners'.
    
    Returns:
    Value for property 'pagerListeners'.
  - getGridListeners
```
protected List<GridListener> getGridListeners()
```
    Getter for property 'gridListeners'.
    
    Returns:
    Value for property 'gridListeners'.
  - getToolbarListeners
```
protected List<GridToolbarListener> getToolbarListeners()
```
    Getter for property 'toolbarListeners'.
    
    Returns:
    Value for property 'toolbarListeners'.
  - setCurrentPageNumber
```
protected void setCurrentPageNumber(GridDataModel model,
                        Pager pager)
```
    This method sets a curent page number.
    
    Parameters:
    model - is a grid data model
    pager - is a pager instance.

Class EventMediator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EventMediator

Method Detail

onPageChange

onSort

onSave

onClear

onAddClick

onRemoveClick

onSaveClick

onClearClick

onSelect

firePageChangeEvent

fireSaveEvent

fireSortEvent

fireClearEvent

fireAddRowEvent

fireRemoveRowEvent

fireSaveEvent

fireClearEvent

fireMoveLeftEvent

fireMoveRightEvent

onMoveLeftClick

onMoveRightClick

addPagerListener

removePagerListener

addGridListener

removeGridListener

addToolbarListener

removeToolbarListener

onModelEvent

getPanel

getPagerListeners

getGridListeners

getToolbarListeners

setCurrentPageNumber