hep.wired.cut

Interface ConditionDefinition

All Known Implementing Classes:

AbstractConditionDefinition, BooleanConditionDefinition, DoubleConditionDefinition, IntegerConditionDefinition, LongConditionDefinition, StringConditionDefinition

public interface ConditionDefinition

Definition of a condition used to filter displayable objects based on a single attribute value.

Version:

$Id: ConditionDefinition.java 13824 2011-05-04 18:30:02Z onoprien $

Author:

Mark Donszelmann, Dmitry Onoprienko

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConditionDefinition.Type

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener) Adds change listener.
void	addToDomain(org.freehep.util.Value value) Updates the domain to ensure it contains the specified value.
Condition	createCondition() Returns a new Condition object linked to this ConditionDefinition.
Condition	createCondition(boolean enabled, boolean inverted) Returns a new Condition object linked to this ConditionDefinition.
String	getDescription() Returns a brief description of the condition.
Object	getDomain() Returns the domain of possible values for the condition.
String	getName() Returns the name of this definition.
ConditionDefinition.Type	getType() Returns the type of this condition.
String	getUnit() Returns the unit name for conditions based on numerical value.
boolean	getValueIsAdjusting() Returns valueIsAdjusting property.
void	remove() Signals to all registered conditions that this definition is being deleted.
void	removeChangeListener(ChangeListener listener) Removes change listener.
void	removeCondition(Condition condition) Unregisters the specified Condition.
void	setDomain(Object domain) Sets the domain of possible values for the condition.
void	setValueIsAdjusting(boolean isValueAdjusting) Sets valueIsAdjusting property.

Method Detail

getName

String getName()

Returns the name of this definition.

getUnit

String getUnit()

Returns the unit name for conditions based on numerical value.

getDescription

String getDescription()

Returns a brief description of the condition.

getType

ConditionDefinition.Type getType()

Returns the type of this condition.

createCondition

Condition createCondition()

Returns a new Condition object linked to this ConditionDefinition. The newly created Condition is registered with this ConditionDefinition. Conditions created with this method are not enabled and not inverted.

createCondition

Condition createCondition(boolean enabled,
                        boolean inverted)

Returns a new Condition object linked to this ConditionDefinition. The newly created Condition is registered with this ConditionDefinition.

removeCondition

void removeCondition(Condition condition)

Unregisters the specified Condition.

remove

void remove()

Signals to all registered conditions that this definition is being deleted.

setDomain

void setDomain(Object domain)

Sets the domain of possible values for the condition. The actual type of object used to describe domain and its interpretation depends on the type of the condition. Calling this method with null argument should reset the domain to an empty set unless the domain is fixed (like in boolean conditions).

getDomain

Object getDomain()

Returns the domain of possible values for the condition. The actual type of object used to describe domain and its interpretation depends on the type of the condition.

addToDomain

void addToDomain(org.freehep.util.Value value)

Updates the domain to ensure it contains the specified value.

addChangeListener

void addChangeListener(ChangeListener listener)

Adds change listener.

removeChangeListener

void removeChangeListener(ChangeListener listener)

Removes change listener.

setValueIsAdjusting

void setValueIsAdjusting(boolean isValueAdjusting)

Sets valueIsAdjusting property. Change events are not generated while the property is set to false. An event is generated when the property is set to true.

getValueIsAdjusting

boolean getValueIsAdjusting()

Returns valueIsAdjusting property. Change events are not generated while the property is set to false.