de.esoco.process.ui

Class UiElement<E extends UiElement<E>>

java.lang.Object

de.esoco.process.ui.UiElement<E>

Direct Known Subclasses:

UiImageDefinition, UiLayoutElement, UiStyle

public class UiElement<E extends UiElement<E>>
extends java.lang.Object

A common base class for elements in the process UI framework.

Constructor Summary

Constructors

Modifier	Constructor and Description
	UiElement() Creates a new instance.
protected	UiElement(UiElement<?> rOther) A copy constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
protected void	applyPropertiesTo(UiComponent<?,?> rComponent) Applies the properties of this element to the given component.
void	applyTo(UiComponent<?,?> rComponent) Applies this element to the given component.
protected void	clearProperties() Clears all properties in this element.
protected void	copyPropertiesFrom(UiElement<?> rOther, boolean bReplace) Copies the properties from another UI element to this instance.
int	get(de.esoco.lib.property.PropertyName<java.lang.Integer> rIntegerProperty, int nDefault) Queries an integer property.
<T> T	get(de.esoco.lib.property.PropertyName<T> rPropertyName, T rDefault) Queries a certain property.
boolean	hasProperty(de.esoco.lib.property.PropertyName<?> rPropertyName) Checks whether a certain property has been set.
boolean	isModified() Checks the modification state of this element.
protected E	set(de.esoco.lib.property.PropertyName<java.lang.Boolean> rFlag) Sets a boolean property.
protected E	set(de.esoco.lib.property.PropertyName<java.lang.Integer> rProperty, int nValue) Sets an integer property.
protected <V> E	set(de.esoco.lib.property.PropertyName<V> rProperty, V rValue) Sets a certain property of this element.
void	setModified(boolean bModified) Set this element's modified state.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UiElement

public UiElement()

Creates a new instance.

UiElement

protected UiElement(UiElement<?> rOther)

A copy constructor for subclasses.

Parameters:

rOther - The other element to copy the properties from

Method Detail

applyTo

public void applyTo(UiComponent<?,?> rComponent)

Applies this element to the given component.

Parameters:

rComponent - The target component

get

public final int get(de.esoco.lib.property.PropertyName<java.lang.Integer> rIntegerProperty,
                     int nDefault)

Queries an integer property.

Parameters:

rIntegerProperty - The property name

nDefault - The default value to return if the property doesn't exist

Returns:

The property value or the default value if it isn't set

get

public final <T> T get(de.esoco.lib.property.PropertyName<T> rPropertyName,
                       T rDefault)

Queries a certain property.

Parameters:

rPropertyName - The property name

rDefault - The default value to return if the property doesn't exist

Returns:

The property value or the default value if it isn't set

hasProperty

public boolean hasProperty(de.esoco.lib.property.PropertyName<?> rPropertyName)

Checks whether a certain property has been set.

Parameters:

rPropertyName - The property name

Returns:

TRUE if the property exists

isModified

public final boolean isModified()

Checks the modification state of this element.

Returns:

TRUE if the element has been modified since it has last been applied to the component

setModified

public final void setModified(boolean bModified)

Set this element's modified state. If TRUE it will be applied to the component on the next call to applyTo(UiComponent).

Parameters:

bModified - The new modified state

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

applyPropertiesTo

protected void applyPropertiesTo(UiComponent<?,?> rComponent)

Applies the properties of this element to the given component. Will only be invoked if the properties have changed.

Parameters:

rComponent - The target component

clearProperties

protected void clearProperties()

Clears all properties in this element.

copyPropertiesFrom

protected void copyPropertiesFrom(UiElement<?> rOther,
                                  boolean bReplace)

Copies the properties from another UI element to this instance.

Parameters:

rOther - The other element

bReplace - TRUE to replace existing properties in this instance

set

protected final E set(de.esoco.lib.property.PropertyName<java.lang.Boolean> rFlag)

Sets a boolean property.

See Also:

set(PropertyName, Object)

set

protected <V> E set(de.esoco.lib.property.PropertyName<V> rProperty,
                    V rValue)

Sets a certain property of this element. All other property set methods redirect to this method so that subclasses only need to override this method if they want to intercept property updates.

Parameters:

rProperty - The property name

rValue - The property value

Returns:

This instance for concatenation

set

protected final E set(de.esoco.lib.property.PropertyName<java.lang.Integer> rProperty,
                      int nValue)

Sets an integer property.

See Also:

set(PropertyName, Object)