com.levigo.jadice.document.render
Class InventoryRenderSettingsEvent

java.lang.Object
  com.levigo.jadice.document.render.RenderSettingsEvent
      com.levigo.jadice.document.render.InventoryRenderSettingsEvent

All Implemented Interfaces:

Serializable

public class InventoryRenderSettingsEvent
extends RenderSettingsEvent

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 RenderSettingsEvent.getSource(). If available, the RenderControls instance which the render setting belongs to can be accessed by a call of RenderSettingsEvent.getSourceControls().

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

See Also:

Serialized Form

Constructor Summary

InventoryRenderSettingsEvent(RenderControlInventory inv, Page page, RenderControls rc, RenderSettings source, String propertyName, Object oldValue, Object newValue)
Constructor

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

Method Summary

RenderControlInventory	getInventory() Returns the render control inventory in which the change happens
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

Methods inherited from class com.levigo.jadice.document.render.RenderSettingsEvent

getNewValue, getOldValue, getPropertyName, getSource, getSourceControls, paramString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InventoryRenderSettingsEvent

public InventoryRenderSettingsEvent(RenderControlInventory inv,
                                    Page page,
                                    RenderControls rc,
                                    RenderSettings source,
                                    String propertyName,
                                    Object oldValue,
                                    Object newValue)

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

source - 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 Detail

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