NodeControlInfo

All Known Implementing Classes:: BasicNodeControlInfo

public interface NodeControlInfo

API for a user-manageable node component.

Version:: 1.0
Author:: matt

Method Summary

Modifier and Type

Method

Description

String

getControlId()

Get the control ID.

String

getPropertyName()

Get an optional control property name.

Boolean

getReadonly()

Get a read-only flag.

NodeControlPropertyType

getType()

Get the control property type.

String

getUnit()

Get an optional unit of measure for the control value.

String

getValue()

Get the control value.

Method Details
- getControlId
  
  String getControlId()
  
  Get the control ID.
  
  Returns:
  
  the control ID
- getPropertyName
  
  String getPropertyName()
  
  Get an optional control property name.
  
  Returns:
  
  the control property name, or null
- getType
  
  NodeControlPropertyType getType()
  
  Get the control property type.
  
  Returns:
  
  the property type
- getValue
  
  String getValue()
  
  Get the control value.
  
  Returns:
  
  the value
- getReadonly
  
  Boolean getReadonly()
  
  Get a read-only flag.
  
  Returns:
  
  the read-only flag
- getUnit
  
  String getUnit()
  
  Get an optional unit of measure for the control value.
  
  Returns:
  
  the unit of measure, or null