VRJConfig UI API
v2.0


org.vrjuggler.vrjconfig.commoneditors.devicegraph
Interface DeviceUnitPropertyHandler

All Known Implementing Classes:
AbstractDeviceUnitPropertyHandler, DefaultUnitPropertyHandler, SimAnalogUnitPropertyHandler

public interface DeviceUnitPropertyHandler

The interface for delegates used by DeviceInfo for managing the device units of a configured device.

User code should not invoke the methods of this class directly. Instead, instances of this interface must be handed off to new instances of DeviceInfo. Such objects will handle the use of this interface to manage the device units.

See Also:
DeviceInfo

Method Summary
 void addDeviceUnitListener(DeviceUnitListener l)
          Adds the given DeviceUnitListener to the list of listeners.
 void addUnit(Integer unitType)
          Adds a new unit of the given type to the device managed by this handler.
 Collection getUnitTypes()
          Returns the unit types for this handler.
 void propertyValueAdded(ConfigElementEvent evt)
          Invoked when a property value is added to the config element being held by this handler.
 void propertyValueChanged(ConfigElementEvent evt)
          Invoked when a property value is changed in the config element being held by this handler.
 void propertyValueOrderChanged(ConfigElementEvent evt)
          Invoked when the order of property values is changed in the config element being held by this handler.
 void propertyValueRemoved(ConfigElementEvent evt)
          Invoked when a property value is removed from the config element being held by this handler.
 void removeDeviceUnitListener(DeviceUnitListener l)
          Removes the given DeviceUnitListener to from list of listeners.
 void removeUnit(Integer unitType, int unitNumber)
          Removes the identified unit of the given type from the device managed by this handler.
 void setConfig(ConfigContext ctx, ConfigElement elt)
          Sets the configuration information for the configured device.
 void setUnitTypeMap(Map unitTypeMap)
          Sets the unit type map for the configured device.
 

Method Detail

setConfig

void setConfig(ConfigContext ctx,
               ConfigElement elt)
Sets the configuration information for the configured device.


setUnitTypeMap

void setUnitTypeMap(Map unitTypeMap)
Sets the unit type map for the configured device. The map must map from Integer to some type, as defined in UnitConstants. The values of the map are dependent upon the specific implementation of this interface.

See Also:
UnitConstants

getUnitTypes

Collection getUnitTypes()
Returns the unit types for this handler. This is a collection of Integer objects as defined in UnitConstants.

See Also:
UnitConstants

propertyValueAdded

void propertyValueAdded(ConfigElementEvent evt)
Invoked when a property value is added to the config element being held by this handler. Whether this results in a DeviceUnitEvent event being generated is dependent upon the specific implementation of this interface.


propertyValueChanged

void propertyValueChanged(ConfigElementEvent evt)
Invoked when a property value is changed in the config element being held by this handler. Whether this results in a DeviceUnitEvent event being generated is dependent upon the specific implementation of this interface.


propertyValueOrderChanged

void propertyValueOrderChanged(ConfigElementEvent evt)
Invoked when the order of property values is changed in the config element being held by this handler. Whether this results in a DeviceUnitEvent event being generated is dependent upon the specific implementation of this interface.


propertyValueRemoved

void propertyValueRemoved(ConfigElementEvent evt)
Invoked when a property value is removed from the config element being held by this handler. Whether this results in a DeviceUnitEvent event being generated is dependent upon the specific implementation of this interface.


addUnit

void addUnit(Integer unitType)
Adds a new unit of the given type to the device managed by this handler.

Parameters:
unitType - the type (as defined in UnitConstants of the device unit to be added)
See Also:
UnitConstants

removeUnit

void removeUnit(Integer unitType,
                int unitNumber)
Removes the identified unit of the given type from the device managed by this handler.

Parameters:
unitType - the type (as defined in UnitConstants of the device unit to be added)
unitNumber - the index of the unit to remove
See Also:
UnitConstants

addDeviceUnitListener

void addDeviceUnitListener(DeviceUnitListener l)
Adds the given DeviceUnitListener to the list of listeners.


removeDeviceUnitListener

void removeDeviceUnitListener(DeviceUnitListener l)
Removes the given DeviceUnitListener to from list of listeners.


VRJConfig UI API
v2.0


Copyright © 1998–2005 Iowa State University. All rights reserved.