org.fujion.component

Class BaseComponent.ComponentReference<T extends BaseComponent>

java.lang.Object

org.fujion.component.BaseComponent.ComponentReference<T>

Type Parameters:

T - The type of the reference component.

All Implemented Interfaces:

IElementIdentifier, IClientTransform, IEventListener

Enclosing class:

BaseComponent

public class BaseComponent.ComponentReference<T extends BaseComponent>
extends Object
implements IElementIdentifier, IEventListener

Used to wrap a component that is referenced by another component for purposes other than parent-child relationships. This wrapper serves two functions. First, it tracks the lifecycle of the referenced component, removing the reference when the component is destroyed. Second, when a component reference is passed to the synchronizer, this wrapper ensures that it is connected to the active page.

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
ComponentReference()
ComponentReference(Consumer<BaseComponent> onDestroy)
ComponentReference(T component)
ComponentReference(T component, Consumer<BaseComponent> onDestroy)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
protected void	finalize()
String	getId() Returns the id of the referenced component, or null if there is no referenced component.
T	getReference() Returns the referenced component.
void	onEvent(Event event) Handle the destroy event.
boolean	setReference(T component) Sets the referenced component, removing any previous reference.
Object	transformForClient() Prior to performing the transform, ensure that the referenced component is attached to the active page.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentReference

public ComponentReference()

ComponentReference

public ComponentReference(T component)

ComponentReference

public ComponentReference(Consumer<BaseComponent> onDestroy)

ComponentReference

public ComponentReference(T component,
                          Consumer<BaseComponent> onDestroy)

Method Detail

getReference

public T getReference()

Returns the referenced component.

Returns:

The referenced component (possibly null).

setReference

public boolean setReference(T component)

Sets the referenced component, removing any previous reference.

Parameters:

component - The referenced component.

Returns:

True if the referenced component changed.

getId

public String getId()

Returns the id of the referenced component, or null if there is no referenced component.

Specified by:

getId in interface IElementIdentifier

Returns:

HTML element unique identifier.

transformForClient

public Object transformForClient()

Prior to performing the transform, ensure that the referenced component is attached to the active page.

Specified by:

transformForClient in interface IElementIdentifier

Specified by:

transformForClient in interface IClientTransform

Returns:

Transformed value.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

finalize

protected void finalize()

Overrides:

finalize in class Object

onEvent

public void onEvent(Event event)

Handle the destroy event.

Specified by:

onEvent in interface IEventListener

Parameters:

event - The destroy event.