com.monad.homerun.control
Class Control

java.lang.Object
  com.monad.homerun.control.Control

All Implemented Interfaces:

java.io.Serializable

public class Control
extends java.lang.Object
implements java.io.Serializable

Control contains the identifiers of a control

See Also:

Serialized Form

Constructor Summary

Control()

Control(java.lang.String name, java.lang.String type, java.lang.String displayName, java.lang.String serviceId, java.lang.String iconName, java.lang.String[] actions, java.lang.String[] codes)

Method Summary

java.lang.String	getActionCode(java.lang.String actionName) Returns the internal name of a control point from the display name
java.lang.String[]	getActionNames() Returns the list of control point display names
java.util.List<Specifier>	getCommonInputs() Returns inputs common to all control points
java.lang.String	getControlName() Returns the name of the control - globally unique
ControlPoint	getControlPoint(java.lang.String pointName) Return a control point for a display name
ControlPoint[]	getControlPoints() Return the control points
java.lang.String	getControlType() Return the control type
java.lang.String	getDisplayName() Returns the displayable name for the control
java.lang.String	getIconName() Returns the name of the icon associated with the control
java.lang.String	getServiceId() Returns the optional serviceID
Specifier[]	getSpecifiers() Returns the list of control specifiers
boolean	hasInputs() Indicates if control has any inputs
boolean	isMultiBind() Can the control be bound to an object more than once?
void	setIconName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Control

public Control()

Control

public Control(java.lang.String name,
               java.lang.String type,
               java.lang.String displayName,
               java.lang.String serviceId,
               java.lang.String iconName,
               java.lang.String[] actions,
               java.lang.String[] codes)

Method Detail

getControlName

public java.lang.String getControlName()

Returns the name of the control - globally unique

Returns:

the control name

getControlType

public java.lang.String getControlType()

Return the control type

Returns:

the control type

getDisplayName

public java.lang.String getDisplayName()

Returns the displayable name for the control

Returns:

the display name

getServiceId

public java.lang.String getServiceId()

Returns the optional serviceID

Returns:

service ID string

getIconName

public java.lang.String getIconName()

Returns the name of the icon associated with the control

Returns:

the control icon name

setIconName

public void setIconName(java.lang.String name)

isMultiBind

public boolean isMultiBind()

Can the control be bound to an object more than once?

Returns:

true if control can bind multiply, false otherwise

getActionNames

public java.lang.String[] getActionNames()

Returns the list of control point display names

Returns:

the display names of control points

getActionCode

public java.lang.String getActionCode(java.lang.String actionName)

Returns the internal name of a control point from the display name

Parameters:

actionName - the display name

Returns:

the internal name (code)

getControlPoints

public ControlPoint[] getControlPoints()

Return the control points

Returns:

an array of control points, 0-length of absent

getControlPoint

public ControlPoint getControlPoint(java.lang.String pointName)

Return a control point for a display name

Parameters:

pointName - - the display name of control point

Returns:

the control point

hasInputs

public boolean hasInputs()

Indicates if control has any inputs

Returns:

true if control has inputs, false otherwise

getCommonInputs

public java.util.List<Specifier> getCommonInputs()

Returns inputs common to all control points

Returns:

inputs - a specifier array of inputs common to all control points

getSpecifiers

public Specifier[] getSpecifiers()

Returns the list of control specifiers

Returns:

a specifier array, 0-length if none present