Package com.levigo.jadice.web.client.settings

Class InventoryRenderSettingsEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<InventoryRenderSettingsEvent.Handler>

com.google.gwt.event.shared.GwtEvent<InventoryRenderSettingsEvent.Handler>

com.levigo.jadice.web.client.event.JadiceEvent<InventoryRenderSettingsEvent.Handler>

com.levigo.jadice.web.client.settings.InventoryRenderSettingsEvent

public class InventoryRenderSettingsEvent
extends JadiceEvent<InventoryRenderSettingsEvent.Handler>

This event gets delivered whenever a RenderSettings, which supports the propagation of changes, has been changed in a RenderControlInventory.

The RenderControlInventory in which the change happens is accessible by a call of getInventory(). If the change concerns a page specific settings the page instance can be retrieved by a call of the getPage() method. Otherwise if the change concerns the document settings the getPage() method always will return null.

Provided by its super class this event allows the access to the name, the old and new value of the changed property. If the new value is a primitive type (such as int or boolean) it must be wrapped as the corresponding java.lang.* object type (such as Integer or Boolean).

Null values may be provided for the old and the new values if their true values are not known.

A reference of the changed RenderSettings can be obtained by a call of JadiceEvent.getSource(). If available, the RenderControls instance which the render setting belongs to can be accessed by a call of getSourceControls().

The types of render settings which support change event propagation are descendants of AbstractListenableRenderSettings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InventoryRenderSettingsEvent.Handler	Handler for handling changes in the InventoryRenderSettings.

Nested classes/interfaces inherited from class com.levigo.jadice.web.client.event.JadiceEvent

JadiceEvent.Type<H>

Constructor Summary

Constructors

Constructor	Description
InventoryRenderSettingsEvent(RenderControlInventory inv, Page page, RenderSettingsEvent evt)	Constructor
InventoryRenderSettingsEvent(RenderControlInventory inv, Page page, RenderControls rc, RenderSettings renderSettings, String propertyName, Object oldValue, Object newValue, com.google.gwt.event.shared.HasHandlers source)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	dispatch(InventoryRenderSettingsEvent.Handler handler)
final JadiceEvent.Type<InventoryRenderSettingsEvent.Handler>	getAssociatedType()
RenderControlInventory	getInventory()	Returns the render control inventory in which the change happens
Object	getNewValue()	Gets the new value of the changed setting, expressed as an Object.
Object	getOldValue()	Gets the old value of the changed setting, expressed as an Object.
Page	getPage()	Returns the page reference if the change concerns page specific settings, or null if a change of the document render settings cause this event
String	getPropertyName()	Gets the name of the setting that was changed.
RenderSettings	getRenderSettings()	Returns the source which caused this event.
RenderControls	getSourceControls()	Returns the RenderControls instance the source RenderSettings belongs to.
static JadiceEvent.Type<InventoryRenderSettingsEvent.Handler>	getType()

Methods inherited from class com.levigo.jadice.web.client.event.JadiceEvent

getSource

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, toString

Methods inherited from class java.lang.Object

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

Constructor Details

InventoryRenderSettingsEvent

public InventoryRenderSettingsEvent(RenderControlInventory inv,
 Page page,
 RenderControls rc,
 RenderSettings renderSettings,
 String propertyName,
 Object oldValue,
 Object newValue,
 com.google.gwt.event.shared.HasHandlers source)

Constructor

Parameters:

inv - the changed render control inventory

page - the page reference if the change concerns page specific settings, or null if a change of the document render settings cause this event

rc - the render controls object the changed render settings belonging to

renderSettings - the changed render settings object

propertyName - the name of the changed property

oldValue - the old value of the property

newValue - the new value of the property

InventoryRenderSettingsEvent

public InventoryRenderSettingsEvent(RenderControlInventory inv,
 Page page,
 RenderSettingsEvent evt)

Constructor

Parameters:

inv - the changed render control inventory

page - the page reference if the change concerns page specific settings, or null if a change of the document render settings cause this event

evt - the event which originates this event

Method Details

getType

public static JadiceEvent.Type<InventoryRenderSettingsEvent.Handler> getType()

getInventory

public RenderControlInventory getInventory()

Returns the render control inventory in which the change happens

Returns:

RenderControlInventory

getPage

public Page getPage()

Returns the page reference if the change concerns page specific settings, or null if a change of the document render settings cause this event

Returns:

page or null

getRenderSettings

public RenderSettings getRenderSettings()

Returns the source which caused this event.

Returns:

the RenderSettings instance that caused this event

getSourceControls

public RenderControls getSourceControls()

Returns the RenderControls instance the source RenderSettings belongs to. May be null if unknown.

Returns:

the RenderControls instance the source belongs to

getPropertyName

public String getPropertyName()

Gets the name of the setting that was changed.

Returns:

The name of the setting that was changed.

getNewValue

public Object getNewValue()

Gets the new value of the changed setting, expressed as an Object.

Returns:

The new value, expressed as an Object.

getOldValue

public Object getOldValue()

Gets the old value of the changed setting, expressed as an Object.

Returns:

The old value, expressed as an Object.

getAssociatedType

public final JadiceEvent.Type<InventoryRenderSettingsEvent.Handler> getAssociatedType()

Specified by:

getAssociatedType in class com.google.gwt.event.shared.GwtEvent<InventoryRenderSettingsEvent.Handler>

dispatch

protected void dispatch(InventoryRenderSettingsEvent.Handler handler)

Specified by:

dispatch in class com.google.gwt.event.shared.GwtEvent<InventoryRenderSettingsEvent.Handler>