com.iizix.prop

Interface IPropReference

All Known Subinterfaces:

IPropReference2

All Known Implementing Classes:

AbstractBaseRelativeReference, AbstractClientBaseRelativeReference, AbstractFixedVirtualizedBaseRelativeReference, AbstractReference, AssetReference, BackgroundImageReference, ContextMenuReference, DatabaseTransactionReference, EditorSelectorReference, EditorVSFocusReference, EditorVSOnUIEvent, FixedVirtualizedAbstractReference, GAnnotation, ImageReference, KStringHolder.TagReference, LabelForReference, PanelPartReference, ScreenActionReference, ScreenFieldReference, SelectorReference, ServerConfigEnvReference, TextTableReference, VSActionActorParticipant, VSActionReference, VSColumnReference, VSComponentReference, VSFieldReference, VSFocusReference, VSGroupReference, VSOnUIEvent, VSParticipant, VSParticipantReference, VSReference, VSRelativeReference, VSTableColumnReference, VSTableReference, WebServiceReference

public interface IPropReference

Interface used as notifier for a property reference listener, see the com.iizix.prop.PropReference class for more information.

Author:

Christopher Mindus

See Also:

PropReference

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPropReference.ReferenceChangeEvent Enumeration for reference change events.

Method Summary

Modifier and Type	Method and Description
String	getReferenceDescription() Gets a short description of this reference, e.g.
boolean	isReferenceValid(GProp<?> property) Validates the property reference that has been looked up.
void	onReferenceEvent(PropReference reference, IPropReference.ReferenceChangeEvent event, GEvent triggerEvent) Called when a property reference event occurs.

Method Detail

onReferenceEvent

void onReferenceEvent(PropReference reference,
                      IPropReference.ReferenceChangeEvent event,
                      GEvent triggerEvent)

Called when a property reference event occurs. The events are ReferenceChangeEvent.FOUND, FOUND_WRONG_CLASS, RENAMED, MOVED, NEW_PROPERTY, BROKEN.

Trigger GEvent's are: PROP_RENAMED, PROP_CNR_RENAMED or PROP_PROJECT_RENAMED for "RENAMED", PROP_DISPOSED for DISPOSED. The PROP_RESOLVE_REFERENCES can sometimes cause the trigger event to be set.

Parameters:

reference - The property reference object.

event - The event.

triggerEvent - The event that triggered this reference event, null for none.

isReferenceValid

boolean isReferenceValid(GProp<?> property)

Validates the property reference that has been looked up.

Parameters:

property - The property to validate.

Returns:

true if valid, false otherwise.

getReferenceDescription

String getReferenceDescription()

Gets a short description of this reference, e.g. "VirtualSpace" or "Label For".

Returns:

The reference description string.