com.highqsoft.athosconfig.gui

Class Variable

java.lang.Object

com.highqsoft.athosconfig.gui.Variable

All Implemented Interfaces:

VariableIF

Direct Known Subclasses:

DT_BOOLEAN, DT_CHAR, DT_FILESelection, DT_STRING

public abstract class Variable
extends java.lang.Object
implements VariableIF

This class is the basic class for classes that want to implement VariableI

Since:

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

Version:

$Revision: 1.12 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested classes/interfaces inherited from interface com.highqsoft.athosconfig.VariableIF

VariableIF.ACCESS_MODE, VariableIF.ACCESS_USER_TYPES

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	changed

Constructor Summary

Constructors

Constructor and Description
Variable(org.w3c.dom.Element var) This constructor receives the element described by this GUI component.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdoptListener(AdoptListener listener) add an adopt callback
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.
protected java.lang.String	getDefaultValue() Get the default value.
java.lang.String	getDescription() Get the description of the variable.
java.lang.String	getElementValue() GetElement value.
abstract 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.
org.w3c.dom.Element	getVariable() Get the variable describing this class.
boolean	hasAccessRight(VariableIF.ACCESS_MODE accessMode, VariableIF.ACCESS_USER_TYPES accessUserType) Checks the access right for the given user_type and access mode
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.
protected boolean	isThereADefault() Get a boolean when a default is available.
static boolean	isVarEnvironment(org.w3c.dom.Element variable) Return a boolean whether the variable must be defined in environment.
static boolean	isVarGlobal(org.w3c.dom.Element variable) Return a boolean whether the variable is global in ini file.
boolean	isVarIniFile(org.w3c.dom.Element variable) Return a boolean whether the variable must be defined in INI file.
void	removeAdoptListener(AdoptListener listener) Remove an adopt callback
void	removeComment() Remove the comment belongs to variable.
void	reset() Reset all settings to the attribute value string.
void	setChanged(boolean flag) Set the boolean whether the changed the variable value.
void	setComment(java.lang.String sval) 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 current gui settings.
void	setElementValue() Configure the element according to the current gui settings.
void	setToDefault() Set all settings of this variable to the default.
abstract void	setValue(java.lang.String def) Set the GUI to a state that is represented by the given string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.highqsoft.athosconfig.VariableIF

getValue

Field Detail

changed

protected boolean changed

Constructor Detail

Variable

public Variable(org.w3c.dom.Element var)

This constructor receives the element described by this GUI component.

Parameters:

var - The element describes the variable.

Method Detail

isChanged

public boolean isChanged()

Return a boolean whether the changed the variable value.

Specified by:

isChanged in interface VariableIF

setChanged

public void setChanged(boolean flag)

Set the boolean whether the changed the variable value.

Specified by:

setChanged in interface VariableIF

getVariable

public org.w3c.dom.Element getVariable()

Get the variable describing this class.

Specified by:

getVariable in interface VariableIF

Returns:

the element belongs to that class.

getLabel

public javax.swing.JComponent getLabel()

This method returns the label component of the variable.

Specified by:

getLabel in interface VariableIF

Returns:

The label component.

getInput

public abstract javax.swing.JComponent getInput()

Get the input component of the variable.

Specified by:

getInput in interface VariableIF

Returns:

the input component.

getDefaultComponent

public javax.swing.JComponent getDefaultComponent()

Get the component to let the user set the default.

Specified by:

getDefaultComponent in interface VariableIF

Returns:

teh default component.

getResetComponent

public javax.swing.JComponent getResetComponent()

Get the component to let the user reset the value.

Specified by:

getResetComponent in interface VariableIF

Returns:

the reset component.

isThereADefault

protected boolean isThereADefault()

Get a boolean when a default is available.

Returns:

true if there is a default defined.

isDefault

public boolean isDefault()

Has this varibnale the default value.

Specified by:

isDefault in interface VariableIF

isObligatory

public boolean isObligatory()

Is the variable obligatory.

Specified by:

isObligatory in interface VariableIF

Returns:

true if obligatory.

isKernel

public boolean isKernel()

Is this varibale defined in kernel section.

Specified by:

isKernel in interface VariableIF

getDefaultValue

protected java.lang.String getDefaultValue()

Get the default value.

Returns:

true if there is a default defined.

setElementValue

public void setElementValue()
                     throws java.lang.Exception

Configure the element according to the current gui settings.

Specified by:

setElementValue in interface VariableIF

Throws:

java.lang.Exception

setElementToDefault

public void setElementToDefault()

Configure the element according to the current gui settings.

Specified by:

setElementToDefault in interface VariableIF

getElementValue

public java.lang.String getElementValue()

GetElement value.

isGlobal

public boolean isGlobal()

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

Specified by:

isGlobal in interface VariableIF

isEnvironment

public boolean isEnvironment()

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

Specified by:

isEnvironment in interface VariableIF

isIniFile

public boolean isIniFile()

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

Specified by:

isIniFile in interface VariableIF

isVarGlobal

public static boolean isVarGlobal(org.w3c.dom.Element variable)

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

isVarEnvironment

public static boolean isVarEnvironment(org.w3c.dom.Element variable)

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

isVarIniFile

public boolean isVarIniFile(org.w3c.dom.Element variable)

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

setToDefault

public void setToDefault()

Set all settings of this variable to the default.

Specified by:

setToDefault in interface VariableIF

reset

public void reset()

Reset all settings to the attribute value string. If this attribute is not available, set the element to the default.

getCurrentValue

public java.lang.String getCurrentValue()

Get the current string value.

Specified by:

getCurrentValue in interface VariableIF

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescription

public java.lang.String getDescription()

Get the description of the variable.

Specified by:

getDescription in interface VariableIF

getComment

public java.lang.String getComment()

Get the comment belongs to varaibale.

Specified by:

getComment in interface VariableIF

setComment

public void setComment(java.lang.String sval)

Set the comment belongs to variable.

Specified by:

setComment in interface VariableIF

removeComment

public void removeComment()

Remove the comment belongs to variable.

Specified by:

removeComment in interface VariableIF

setValue

public abstract void setValue(java.lang.String def)

Set the GUI to a state that is represented by the given string.

addAdoptListener

public void addAdoptListener(AdoptListener listener)

add an adopt callback

Specified by:

addAdoptListener in interface VariableIF

removeAdoptListener

public void removeAdoptListener(AdoptListener listener)

Remove an adopt callback

Specified by:

removeAdoptListener in interface VariableIF

hasAccessRight

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

Checks the access right for the given user_type and access mode

Specified by:

hasAccessRight in interface VariableIF

setElementAccessRights

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

Sets the new access right for given mode and user type.

Specified by:

setElementAccessRights in interface VariableIF