ilog.views.gantt.property

Class IlvAbstractUserDefinedProperty

java.lang.Object

ilog.views.gantt.property.IlvAbstractStringProperty

ilog.views.gantt.property.IlvAbstractUserDefinedProperty

All Implemented Interfaces:

IlvProperty, IlvStringProperty

Direct Known Subclasses:

IlvActivityUserDefinedProperty, IlvResourceUserDefinedProperty

public abstract class IlvAbstractUserDefinedProperty
extends IlvAbstractStringProperty

IlvAbstractUserDefinedProperty provides a common framework for accessing arbitrary user-defined properties of an IlvUserPropertyHolder via the generic IlvStringProperty interface. A Format can be supplied to convert non-String properties to/from a string. The user-defined property class is also used to try to convert non-String property values to/from a string, when there is no format specified and the property class is not String.

Since:

JViews 8.0

Field Summary

Fields inherited from class ilog.views.gantt.property.IlvAbstractStringProperty

_formatter

Constructor Summary

Constructors

Constructor and Description
IlvAbstractUserDefinedProperty(String userPropertyName) Constructs a new IlvAbstractUserDefinedProperty for the given user-property of class String.
IlvAbstractUserDefinedProperty(String userPropertyName, Class userPropertyClass) Constructs a new IlvAbstractUserDefinedProperty for the given user-property of a given class.

Method Summary

Modifier and Type	Method and Description
Class	getPropertyClass() Gets the class of the user-defined property this adapter is used for.
String	getPropertyName() Gets the name of the user-defined property this adapter is used for.
protected Object	getValueImpl(Object target) /** Returns the value of the property represented by this adapter from the specified target object, or null if the target object is not an IlvUserPropertyHolder
protected void	setValueImpl(Object target, Object value) /** Sets the value of the property represented by this adapter in the specified target object.

Methods inherited from class ilog.views.gantt.property.IlvAbstractStringProperty

changedRowsIterator, getFormat, getValue, isPropertyChangedEvent, setFormat, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.property.IlvProperty

getEventClass

Constructor Detail

IlvAbstractUserDefinedProperty

public IlvAbstractUserDefinedProperty(String userPropertyName)

Constructs a new IlvAbstractUserDefinedProperty for the given user-property of class String.

Parameters:

userPropertyName - the name of the property in the model.

IlvAbstractUserDefinedProperty

public IlvAbstractUserDefinedProperty(String userPropertyName,
                                      Class userPropertyClass)

Constructs a new IlvAbstractUserDefinedProperty for the given user-property of a given class.

Parameters:

userPropertyName - the name of the property in the model.

userPropertyClass - the name of the property in the model.

Method Detail

getPropertyClass

public Class getPropertyClass()

Gets the class of the user-defined property this adapter is used for.

Returns:

The Class of the user-defined property.

getPropertyName

public String getPropertyName()

Gets the name of the user-defined property this adapter is used for.

Returns:

The property name.

getValueImpl

protected Object getValueImpl(Object target)
                       throws IllegalArgumentException

/** Returns the value of the property represented by this adapter from the specified target object, or null if the target object is not an IlvUserPropertyHolder

Specified by:

getValueImpl in class IlvAbstractStringProperty

Parameters:

target - the target object.

Returns:

The property value.

Throws:

IllegalArgumentException - if the property name is null.

See Also:

IlvAbstractStringProperty.getValue(java.lang.Object)

setValueImpl

protected void setValueImpl(Object target,
                            Object value)

/** Sets the value of the property represented by this adapter in the specified target object. If the value is not of the correct type, the value is not set.

Specified by:

setValueImpl in class IlvAbstractStringProperty

Parameters:

target - the target object.

value - the property value of the target object.

Throws:

IllegalArgumentException - if the property name is null, or if the target is not an IlvUserPropertyHolder.

See Also:

IlvAbstractStringProperty.setValue(java.lang.Object, java.lang.String)