org.zkoss.zssex.ui.widget

Class DefaultWidgetHandler

java.lang.Object

org.zkoss.zssex.ui.widget.DefaultWidgetHandler

All Implemented Interfaces:

java.io.Serializable, WidgetHandler

public class DefaultWidgetHandler
extends java.lang.Object
implements WidgetHandler, java.io.Serializable

Author:

Dennis.Chen

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultWidgetHandler()

Method Summary

Modifier and Type	Method and Description
boolean	addWidget(Widget widget) Add widget to a handler, notice : WidgetHandler and Widget are implementation-sensitive.
Spreadsheet	getSpreadsheet() get spreadsheet of this handler
void	init(Spreadsheet spreadsheet) initial a widget handler.
void	invaliate() invalidate this handle, which means all widget in client side will be remove, and need to re-drew.
void	onLoadOnDemand(SSheet sheet, int left, int top, int right, int bottom) call when spreadsheet try to load a block of cell to client side.
boolean	removeWidget(Widget widget) Remove widget from a handler notice : WidgetHandler and Widget are implementation-sensitive.
void	updateWidget(SSheet sheet, java.lang.String widgetId) Redraw widget
void	updateWidgets(SSheet sheet, int left, int top, int right, int bottom) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultWidgetHandler

public DefaultWidgetHandler()

Method Detail

addWidget

public boolean addWidget(Widget widget)

Description copied from interface: WidgetHandler

Add widget to a handler, notice : WidgetHandler and Widget are implementation-sensitive.

Specified by:

addWidget in interface WidgetHandler

Parameters:

widget - a widget

Returns:

true if success to add a widget

updateWidgets

@Deprecated
public void updateWidgets(SSheet sheet,
                                       int left,
                                       int top,
                                       int right,
                                       int bottom)

Deprecated.

use updateWidget(SSheet, String)

Specified by:

updateWidgets in interface WidgetHandler

Parameters:

sheet - the sheet that contents has changed

left - left column of the range

top - top row of the range

right - right column of the range

bottom - bottom row of the range

updateWidget

public void updateWidget(SSheet sheet,
                         java.lang.String widgetId)

Description copied from interface: WidgetHandler

Redraw widget

Specified by:

updateWidget in interface WidgetHandler

getSpreadsheet

public Spreadsheet getSpreadsheet()

Description copied from interface: WidgetHandler

get spreadsheet of this handler

Specified by:

getSpreadsheet in interface WidgetHandler

Returns:

spreadsheet

removeWidget

public boolean removeWidget(Widget widget)

Description copied from interface: WidgetHandler

Remove widget from a handler notice : WidgetHandler and Widget are implementation-sensitive.

Specified by:

removeWidget in interface WidgetHandler

Returns:

true if success to remove a widget

init

public void init(Spreadsheet spreadsheet)

Description copied from interface: WidgetHandler

initial a widget handler. this method will be invoked by spreadsheet, you should not call this method directly.

Specified by:

init in interface WidgetHandler

onLoadOnDemand

public void onLoadOnDemand(SSheet sheet,
                           int left,
                           int top,
                           int right,
                           int bottom)

Description copied from interface: WidgetHandler

call when spreadsheet try to load a block of cell to client side. handler should take care this method and load corresponding widgets, which in the block , to client side. this method will be invoked by spreadsheet, you should not call this method directly.

Specified by:

onLoadOnDemand in interface WidgetHandler

invaliate

public void invaliate()

Description copied from interface: WidgetHandler

invalidate this handle, which means all widget in client side will be remove, and need to re-drew. this method will be invoked when spreadsheet invalidate only.

Specified by:

invaliate in interface WidgetHandler