com.codename1.rad.models

Class EntityList.VetoableEntityEvent

java.lang.Object

com.codename1.ui.events.ActionEvent

com.codename1.rad.controllers.ControllerEvent

com.codename1.rad.models.EntityList.EntityListEvent

com.codename1.rad.models.EntityList.EntityEvent

com.codename1.rad.models.EntityList.VetoableEntityEvent

Direct Known Subclasses:

EntityList.VetoableEntityAddedEvent, EntityList.VetoableEntityRemovedEvent

Enclosing class:

EntityList<T extends Entity>

public static class EntityList.VetoableEntityEvent
extends EntityList.EntityEvent

A type of entity event which is fired before the add/remove occurs, and allows the listener to veto/cancel the add/remove.

This event type can be handy if you need to be notified of a change before it is made, if, for example you need to know the state of the list before the change. This is used by the PropertySelector to detect when sub-properties may have been invalidated because a parent entity has been removed from a list.

Nested Class Summary

Nested classes/interfaces inherited from class com.codename1.ui.events.ActionEvent

ActionEvent.Type

Constructor Summary

Constructors

Constructor and Description
VetoableEntityEvent(EntityList source, Entity entity, int index)

Method Summary

Modifier and Type	Method and Description
String	getReason() Gets the reason for the veto, or null, if no veto was made.
boolean	isVetoed() Checks if the add/remove has been vetoed.
void	veto(String reason) Veto the add/remove.

Methods inherited from class com.codename1.rad.models.EntityList.EntityEvent

getEntity, getIndex, getTransaction, setTransaction

Methods inherited from class com.codename1.rad.controllers.ControllerEvent

as

Methods inherited from class com.codename1.ui.events.ActionEvent

consume, getActualComponent, getCommand, getComponent, getDraggedComponent, getDropTarget, getEventType, getKeyEvent, getProgress, getSource, getX, getY, isConsumed, isLongEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

VetoableEntityEvent

public VetoableEntityEvent(EntityList source,
                           Entity entity,
                           int index)

Method Detail

veto

public void veto(String reason)

Veto the add/remove.

Parameters:

reason - The reason for the veto.

isVetoed

public boolean isVetoed()

Checks if the add/remove has been vetoed.

getReason

public String getReason()

Gets the reason for the veto, or null, if no veto was made.

Returns: