com.ryanm.config
Interface ConfiguratorListener


public interface ConfiguratorListener

Objects that are interested in monitoring the Configurator itself, rather than the values of the variables controlled by the configurator, should implement this interface

Author:
ryanm

Method Summary
 void configuratorDescribed(java.lang.String description)
          Called when the configurator is described
 void variableAdded(java.lang.Object variable)
          Called when a variable has been added to the configurator
 void variableDescribed(java.lang.String variable)
          Called when a variable has a description applied to it
 void variableRanged(java.lang.String variable)
          Called when a variable has a range applied to it
 void variableRemoved(java.lang.Object variable)
          Called when a variable is removed from the Configurator
 void variableStatusChanged(java.lang.String name, boolean enabled)
          Is called by the configurator when a variable is enabled or disabled
 void variableTyped(java.lang.String variable)
          Called when a variable has its type set
 

Method Detail

variableStatusChanged

void variableStatusChanged(java.lang.String name,
                           boolean enabled)
Is called by the configurator when a variable is enabled or disabled

Parameters:
name - The name of the variable
enabled - true if the variable is enabled, false otherwise

variableAdded

void variableAdded(java.lang.Object variable)
Called when a variable has been added to the configurator

Parameters:
variable - The name of the variable, or the Configurator object

variableRemoved

void variableRemoved(java.lang.Object variable)
Called when a variable is removed from the Configurator

Parameters:
variable - the variable or subconfigurator that was removed

variableTyped

void variableTyped(java.lang.String variable)
Called when a variable has its type set

Parameters:
variable - The name of the variable that has been typed

variableRanged

void variableRanged(java.lang.String variable)
Called when a variable has a range applied to it

Parameters:
variable - The name of the variable that has been bounded

variableDescribed

void variableDescribed(java.lang.String variable)
Called when a variable has a description applied to it

Parameters:
variable - The name of the variable that was described

configuratorDescribed

void configuratorDescribed(java.lang.String description)
Called when the configurator is described

Parameters:
description - The new description string