FileDocCategorySizeDatePackage
Parameter.javaAPI DocAzureus 3.0.3.43213Sun Dec 10 13:39:56 GMT 2006org.gudy.azureus2.plugins.ui.config

Parameter

public interface Parameter implements org.gudy.azureus2.plugins.config.ConfigParameter
represents a generic parameter description
author
Olivier

Fields Summary
Constructors Summary
Methods Summary
public voidaddListener(ParameterListener l)
Adds a listener triggered when the parameter is changed by the user

param
l Listener to add
since
2.1.0.2

public java.lang.StringgetLabelKey()
Retrieve the language bundle key for the label associated with this parameter.

return
The language bundle key, or null if the label is using literal text
since
2.3.0.6

public java.lang.StringgetLabelText()
Retrieve the actual text of the label associated with this parameter. This is the text after it has been looked up in the language bundle.

return
The label's text
since
2.3.0.6

public booleanisEnabled()
Retrieves the enabled state for the UI object for this parameter

return
The enabled state
since
2.3.0.0

public booleanisVisible()
Retrieves the visiblility state for the UI object for this parameter

return
The visibility state
since
2.3.0.4

public voidremoveListener(ParameterListener l)
Removes a previously added listener

param
l Listener to remove.
since
2.1.0.2

public voidsetEnabled(boolean enabled)
Sets whether the UI object for this parameter is enabled (changeable) or disabled (not changeable, and usualy grayed out)

param
enabled The new enabled state
since
2.3.0.0

public voidsetLabelKey(java.lang.String sLabelKey)
Set the label to use the supplied language bundle key for the label associated with this parameter

param
sLabelKey The language bundle key to use.
since
2.3.0.6

public voidsetLabelText(java.lang.String sText)
Set the text of the label associated to with this parameter to the literal text supplied.

param
sText The actual text to assign to the label
since
2.3.0.6

public voidsetVisible(boolean visible)
Sets whether the UI object for this parameter is visble to the user

param
visible The new visibility state
since
2.3.0.4