com.highqsoft.athosconfig

Interface VariableIF

All Known Implementing Classes:

DB_PASSWORD, DT_BOOLEAN, DT_CHAR, DT_DIRECTORY, DT_FILE, DT_FILESelection, DT_FLOAT, DT_INT, DT_LONG, DT_STRING, Variable

public interface VariableIF

This interface must be fulfilled by any varibale that should be displayed in the configuration window. Normally a class implementing this interface will be generated by the GUIFactory.

Since:

$Date: 2017/04/06 13:28:26 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VariableIF.ACCESS_MODE
static class	VariableIF.ACCESS_USER_TYPES

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdoptListener(AdoptListener listener) add an adopt listener
java.lang.String	getComment() Get the comment belongs to varaibale.
java.lang.String	getCurrentValue() Get the current string value.
javax.swing.JComponent	getDefaultComponent() Get the component to let the user set the default.
java.lang.String	getDescription() Get the description of the variable.
javax.swing.JComponent	getInput() Get the input component of the variable.
javax.swing.JComponent	getLabel() This method returns the label component of the variable.
javax.swing.JComponent	getResetComponent() Get the component to let the user reset the value.
java.lang.String	getValue() Read the user input from input component.
org.w3c.dom.Element	getVariable() Get the variable describing this class.
boolean	hasAccessRight(VariableIF.ACCESS_MODE accessMode, VariableIF.ACCESS_USER_TYPES accessUserType) Returns whether the given user_type has the access right
boolean	isChanged() Return a boolean whether the changed the variable value.
boolean	isDefault() Has this varibnale the default value.
boolean	isEnvironment() Return a boolean whether the variable must be defined in environment.
boolean	isGlobal() Return a boolean whether the variable is global in ini file.
boolean	isIniFile() Return a boolean whether the variable must be defined in INI file.
boolean	isKernel() Is this varibale defined in kernel section.
boolean	isObligatory() Is the variable obligatory.
void	removeAdoptListener(AdoptListener listener) remove an adopt listener
void	removeComment() Remove the comment belongs to varibale.
void	setChanged(boolean flag) Set the boolean whether the changed the variable value.
void	setComment(java.lang.String comment) Set the comment belongs to variable.
void	setElementAccessRights(VariableIF.ACCESS_MODE mode, VariableIF.ACCESS_USER_TYPES userType, boolean isChecked) Sets the new access right for given mode and user type
void	setElementToDefault() Configure the element according to the default settings.
void	setElementValue() Set the element value attribute according to the current input settings.
void	setToDefault() Set all settings of this variable to the default.

Method Detail

getLabel

javax.swing.JComponent getLabel()

This method returns the label component of the variable.

Returns:

The label component.

getInput

javax.swing.JComponent getInput()

Get the input component of the variable.

Returns:

the input component.

getDefaultComponent

javax.swing.JComponent getDefaultComponent()

Get the component to let the user set the default.

Returns:

the default component.

getResetComponent

javax.swing.JComponent getResetComponent()

Get the component to let the user reset the value.

Returns:

the reset component.

getVariable

org.w3c.dom.Element getVariable()

Get the variable describing this class.

Returns:

the element belongs to that class.

getCurrentValue

java.lang.String getCurrentValue()

Get the current string value.

getDescription

java.lang.String getDescription()

Get the description of the variable.

setToDefault

void setToDefault()

Set all settings of this variable to the default.

isChanged

boolean isChanged()

Return a boolean whether the changed the variable value.

setChanged

void setChanged(boolean flag)

Set the boolean whether the changed the variable value.

isGlobal

boolean isGlobal()

Return a boolean whether the variable is global in ini file.

isEnvironment

boolean isEnvironment()

Return a boolean whether the variable must be defined in environment.

isIniFile

boolean isIniFile()

Return a boolean whether the variable must be defined in INI file.

isObligatory

boolean isObligatory()

Is the variable obligatory.

Returns:

true if obligatory.

isKernel

boolean isKernel()

Is this varibale defined in kernel section.

isDefault

boolean isDefault()

Has this varibnale the default value.

getValue

java.lang.String getValue()
                          throws java.lang.Exception

Read the user input from input component.

Throws:

java.lang.Exception

setElementValue

void setElementValue()
                     throws java.lang.Exception

Set the element value attribute according to the current input settings.

Throws:

java.lang.Exception

setElementToDefault

void setElementToDefault()

Configure the element according to the default settings.

getComment

java.lang.String getComment()

Get the comment belongs to varaibale.

setComment

void setComment(java.lang.String comment)

Set the comment belongs to variable.

removeComment

void removeComment()

Remove the comment belongs to varibale.

addAdoptListener

void addAdoptListener(AdoptListener listener)

add an adopt listener

removeAdoptListener

void removeAdoptListener(AdoptListener listener)

remove an adopt listener

hasAccessRight

boolean hasAccessRight(VariableIF.ACCESS_MODE accessMode,
                     VariableIF.ACCESS_USER_TYPES accessUserType)

Returns whether the given user_type has the access right

setElementAccessRights

void setElementAccessRights(VariableIF.ACCESS_MODE mode,
                          VariableIF.ACCESS_USER_TYPES userType,
                          boolean isChecked)

Sets the new access right for given mode and user type