IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class ColorSettings

java.lang.Object
  extended bycom.ibm.dse.gui.ColorSettings
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ColorSettings
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

The ColorSettings class is used by the SpColorEditor to encapsulate the colors.

See Also:
Serialized Form

Field Summary
static int SPCOMBOBOX
          When typeComponent property is SPCOMBOBOX, ColorSettings is a SpComboBox colors property
static int SPLIST
          When typeComponent property is SPLIST ColorSettings is a SpList colors property
static int SPTABLE
          When typeComponent property is SPTABLE ColorSettings is a SpTable colors property
static int SPTEXTFIELD
          When typeComponent property is SPTEXFIELD, ColorSettings is a SpTextField colors property
 
Constructor Summary
ColorSettings()
          This constructor creates a ColorSettings object.
ColorSettings(java.awt.Color mbc, java.awt.Color mfc, java.awt.Color ebc, java.awt.Color efc, java.awt.Color obc, java.awt.Color ofc, java.awt.Color nedbc, java.awt.Color nedfc, java.awt.Color nenbc, java.awt.Color nenfc, java.awt.Color sbc, java.awt.Color sfc, java.awt.Color caret)
          This constructor creates a ColorSettings object.
ColorSettings(int typeCompo)
          This constructor creates a ColorSettings object.
ColorSettings(int typeCompo, java.awt.Color mbc, java.awt.Color mfc, java.awt.Color ebc, java.awt.Color efc, java.awt.Color obc, java.awt.Color ofc, java.awt.Color nedbc, java.awt.Color nedfc, java.awt.Color nenbc, java.awt.Color nenfc, java.awt.Color sbc, java.awt.Color sfc, java.awt.Color caret)
          This constructor creates a ColorSettings object.
ColorSettings(int typeCompo, int mdbk, int mdfg, int erbk, int erfg, int opbg, int opfg, int nedbg, int nedfg, int nenbg, int nenfg, int caret, int slbg, int slfg)
          This constructor creates a ColorSettings object.
ColorSettings(int type, java.util.Vector vc)
          This constructor creates a ColorSettings object.
 
Method Summary
 java.awt.Color getCaretColor()
          Gets the Caret color property value.
 java.lang.String getCaretColorString()
          Gets the Caret color property value in a Java line code.
 java.awt.Color getErrorBackgroundColor()
          Gets the Error background color property value.
 java.lang.String getErrorBackgroundColorString()
          Gets the Error background color property value in a Java line code.
 java.awt.Color getErrorForegroundColor()
          Gets the Error foreground color property value.
 java.lang.String getErrorForegroundColorString()
          Gets the Error foreground color property value in a Java line code.
 java.awt.Color getMandatoryBackgroundColor()
          Gets the Mandatory background color property value.
 java.lang.String getMandatoryBackgroundColorString()
          Gets the Mandatory background color property value in a Java line code.
 java.awt.Color getMandatoryForegroundColor()
          Gets the Mandatory foreground color property value.
 java.lang.String getMandatoryForegroundColorString()
          Gets the Mandatory foreground color property value in a Java line code.
 java.awt.Color getNonEditableBackgroundColor()
          Gets the Non editable background color property value.
 java.lang.String getNonEditableBackgroundColorString()
          Gets the Non editable background color property value in a Java line code.
 java.awt.Color getNonEditableForegroundColor()
          Gets the Non editable foreground color property value.
 java.lang.String getNonEditableForegroundColorString()
          Gets the Non editable foreground color property value in a Java line code.
 java.awt.Color getNonEnabledBackgroundColor()
          Gets the Non enabled background color property value.
 java.lang.String getNonEnabledBackgroundColorString()
          Gets the Non enabled background color property value in a Java line code.
 java.awt.Color getNonEnabledForegroundColor()
          Gets the Non enabled foreground color property value.
 java.lang.String getNonEnabledForegroundColorString()
          Gets the Non enabled foreground color property value in a Java line code.
 java.awt.Color getOptionalBackgroundColor()
          Gets the Optional background color property value.
 java.lang.String getOptionalBackgroundColorString()
          Gets the Optional background color property value in a Java line code.
 java.awt.Color getOptionalForegroundColor()
          Gets the Optional foreground color property value.
 java.lang.String getOptionalForegroundColorString()
          Gets the Optional foreground color property value in a Java line code.
 java.awt.Color getSelectionBackgroundColor()
          Gets the Selection background color property value.
 java.lang.String getSelectionBackgroundColorString()
          Gets the Selection background color property value in a Java line code.
 java.awt.Color getSelectionForegroundColor()
          Gets the Selection foreground color property value.
 java.lang.String getSelectionForegroundColorString()
          Gets the Selection foreground color property value in a Java line code.
 int getTypeComponent()
          Gets the Type component property value.
 ColorSettings newCopy()
          returns a copy of this object.
 void setCaretColor(java.awt.Color c)
          Sets the Caret color property (java.awt.color) value.
 void setErrorBackgroundColor(java.awt.Color c)
          Sets the Error background color property (java.awt.color) value.
 void setErrorForegroundColor(java.awt.Color c)
          Sets the Error foreground color property (java.awt.color) value.
 void setMandatoryBackgroundColor(java.awt.Color c)
          Sets the Mandatory background color property (java.awt.color) value.
 void setMandatoryForegroundColor(java.awt.Color c)
          Sets the Mandatory foreground color property (java.awt.color) value.
 void setNonEditableBackgroundColor(java.awt.Color c)
          Sets the Non editable background color property (java.awt.color) value.
 void setNonEditableForegroundColor(java.awt.Color c)
          Sets the Non editable foreground color property (java.awt.color) value.
 void setNonEnabledBackgroundColor(java.awt.Color c)
          Sets the Non Enabled background color property (java.awt.color) value.
 void setNonEnabledForegroundColor(java.awt.Color c)
          Sets the Non enabled foreground color property (java.awt.color) value.
 void setOptionalBackgroundColor(java.awt.Color c)
          Sets the Optional background color property (java.awt.color) value.
 void setOptionalForegroundColor(java.awt.Color c)
          Sets the Optional foreground color property (java.awt.color) value.
 void setSelectionBackgroundColor(java.awt.Color c)
          Sets the Selection background color property (java.awt.color) value.
 void setSelectionForegroundColor(java.awt.Color c)
          Sets the Selection foreground color property (java.awt.color) value.
 void setTypeComponent(int typeCompo)
          Sets the Type Component property value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SPTEXTFIELD

public static final int SPTEXTFIELD
When typeComponent property is SPTEXFIELD, ColorSettings is a SpTextField colors property

See Also:
Constant Field Values

SPCOMBOBOX

public static final int SPCOMBOBOX
When typeComponent property is SPCOMBOBOX, ColorSettings is a SpComboBox colors property

See Also:
Constant Field Values

SPLIST

public static final int SPLIST
When typeComponent property is SPLIST ColorSettings is a SpList colors property

See Also:
Constant Field Values

SPTABLE

public static final int SPTABLE
When typeComponent property is SPTABLE ColorSettings is a SpTable colors property

See Also:
Constant Field Values
Constructor Detail

ColorSettings

public ColorSettings()
This constructor creates a ColorSettings object.


ColorSettings

public ColorSettings(int typeCompo)
This constructor creates a ColorSettings object.


ColorSettings

public ColorSettings(int typeCompo,
                     int mdbk,
                     int mdfg,
                     int erbk,
                     int erfg,
                     int opbg,
                     int opfg,
                     int nedbg,
                     int nedfg,
                     int nenbg,
                     int nenfg,
                     int caret,
                     int slbg,
                     int slfg)
This constructor creates a ColorSettings object.

Parameters:
mdbk - int, Mandatory background color (the RGB value representing the color in the default sRGB)
mdfg - int, Mandatory foreground color (the RGB value representing the color in the default sRGB)
erbk - int, Error background color (the RGB value representing the color in the default sRGB)
erfg - int, Error foreground color (the RGB value representing the color in the default sRGB)
opbg - int, Optional background color (the RGB value representing the color in the default sRGB)
opfg - int, Optional foreground color (the RGB value representing the color in the default sRGB)
nedbg - int, NonEditable background color (the RGB value representing the color in the default sRGB)
nedfg - int, NonEditable foreground color (the RGB value representing the color in the default sRGB)
nenbg - int, NonEnabled background color (the RGB value representing the color in the default sRGB)
nenfg - int, NonEnabled foreground color (the RGB value representing the color in the default sRGB)
slbg - int, Selection background color (the RGB value representing the color in the default sRGB)
slfg - int, Selection foreground color (the RGB value representing the color in the default sRGB)
caret - int, Caret color (the RGB value representing the color in the default sRGB)

ColorSettings

public ColorSettings(int typeCompo,
                     java.awt.Color mbc,
                     java.awt.Color mfc,
                     java.awt.Color ebc,
                     java.awt.Color efc,
                     java.awt.Color obc,
                     java.awt.Color ofc,
                     java.awt.Color nedbc,
                     java.awt.Color nedfc,
                     java.awt.Color nenbc,
                     java.awt.Color nenfc,
                     java.awt.Color sbc,
                     java.awt.Color sfc,
                     java.awt.Color caret)
This constructor creates a ColorSettings object.

Parameters:
mbc - java.awt.Color, Mandatory background color
mfc - java.awt.Color, Mandatory foreground color
ebc - java.awt.Color, Error background color
efc - java.awt.Color, Error foreground color
obc - java.awt.Color, Optional background color
ofc - java.awt.Color, Optional foreground color
nedbc - java.awt.Color, Non editable background color
nedfc - java.awt.Color, Non editable foreground color
nenbc - java.awt.Color, Non enabled background color
nenfc - java.awt.Color, Non enabled foreground color
sbc - java.awt.Color, Selection background color
sfc - java.awt.Color, Selection foreground color
caret - java.awt.Color, Caret color

ColorSettings

public ColorSettings(int type,
                     java.util.Vector vc)
This constructor creates a ColorSettings object.

Parameters:
type - int, One of the following constants defined in ColorSettings: SPTEXTFIELD, SPCOMBOBOX, SPLIST or SPTABLE.
vc - java.util.Vector with:
element 0: java.awt.Color Mandatory background color
element 1: java.awt.Color Mandatory foreground color
element 2: java.awt.Color Error background color
element 3: java.awt.Color Error foreground color
element 4: java.awt.Color Optional background color
element 5: java.awt.Color Optional foreground color
element 6: java.awt.Color NonEditable background color
element 7: java.awt.Color NonEditable foreground color
element 8: java.awt.Color NonEnabled background color
element 9: java.awt.Color NonEnabled foreground color
element 10: java.awt.Color Selection background color
element 11: java.awt.Color Selection foreground color
element 12: java.awt.Color Caret color

ColorSettings

public ColorSettings(java.awt.Color mbc,
                     java.awt.Color mfc,
                     java.awt.Color ebc,
                     java.awt.Color efc,
                     java.awt.Color obc,
                     java.awt.Color ofc,
                     java.awt.Color nedbc,
                     java.awt.Color nedfc,
                     java.awt.Color nenbc,
                     java.awt.Color nenfc,
                     java.awt.Color sbc,
                     java.awt.Color sfc,
                     java.awt.Color caret)
This constructor creates a ColorSettings object.

Parameters:
mbc - java.awt.Color, Mandatory background color
mfc - java.awt.Color, Mandatory foreground color
ebc - java.awt.Color, Error background color
efc - java.awt.Color, Error foreground color
obc - java.awt.Color, Optional background color
ofc - java.awt.Color, Optional foreground color
nedbc - java.awt.Color, Non editable background color
nedfc - java.awt.Color, Non editable foreground color
nenbc - java.awt.Color, Non enabled background color
nenfc - java.awt.Color, Non enabled foreground color
sbc - java.awt.Color, Selection background color
sfc - java.awt.Color, Selection foreground color
caret - java.awt.Color, Caret color
Method Detail

getCaretColor

public java.awt.Color getCaretColor()
Gets the Caret color property value.

Returns:
java.awt.Color - Caret color property.

getCaretColorString

public java.lang.String getCaretColorString()
Gets the Caret color property value in a Java line code.

Returns:
String - Java line code.

getErrorBackgroundColor

public java.awt.Color getErrorBackgroundColor()
Gets the Error background color property value.

Returns:
java.awt.Color - Error background color.

getErrorBackgroundColorString

public java.lang.String getErrorBackgroundColorString()
Gets the Error background color property value in a Java line code.

Returns:
String - Java line code.

getErrorForegroundColor

public java.awt.Color getErrorForegroundColor()
Gets the Error foreground color property value.

Returns:
java.awt.Color - Error foreground color.

getErrorForegroundColorString

public java.lang.String getErrorForegroundColorString()
Gets the Error foreground color property value in a Java line code.

Returns:
String - Java line code.

getMandatoryBackgroundColor

public java.awt.Color getMandatoryBackgroundColor()
Gets the Mandatory background color property value.

Returns:
java.awt.Color - Mandatory background color.

getMandatoryBackgroundColorString

public java.lang.String getMandatoryBackgroundColorString()
Gets the Mandatory background color property value in a Java line code.

Returns:
String - Java line code.

getMandatoryForegroundColor

public java.awt.Color getMandatoryForegroundColor()
Gets the Mandatory foreground color property value.

Returns:
java.awt.Color - Mandatory foreground color.

getMandatoryForegroundColorString

public java.lang.String getMandatoryForegroundColorString()
Gets the Mandatory foreground color property value in a Java line code.

Returns:
String - Java line code.

getNonEditableBackgroundColor

public java.awt.Color getNonEditableBackgroundColor()
Gets the Non editable background color property value.

Returns:
java.awt.Color - Non editable background color.

getNonEditableBackgroundColorString

public java.lang.String getNonEditableBackgroundColorString()
Gets the Non editable background color property value in a Java line code.

Returns:
String - Java line code.

getNonEditableForegroundColor

public java.awt.Color getNonEditableForegroundColor()
Gets the Non editable foreground color property value.

Returns:
java.awt.Color - Non editable foreground color

getNonEditableForegroundColorString

public java.lang.String getNonEditableForegroundColorString()
Gets the Non editable foreground color property value in a Java line code.

Returns:
String - Java line code.

getNonEnabledBackgroundColor

public java.awt.Color getNonEnabledBackgroundColor()
Gets the Non enabled background color property value.

Returns:
java.awt.Color - Non enabled background color.

getNonEnabledBackgroundColorString

public java.lang.String getNonEnabledBackgroundColorString()
Gets the Non enabled background color property value in a Java line code.

Returns:
String - Java line code.

getNonEnabledForegroundColor

public java.awt.Color getNonEnabledForegroundColor()
Gets the Non enabled foreground color property value.

Returns:
java.awt.Color - Non enabled foreground color.

getNonEnabledForegroundColorString

public java.lang.String getNonEnabledForegroundColorString()
Gets the Non enabled foreground color property value in a Java line code.

Returns:
String - Java line code.

getOptionalBackgroundColor

public java.awt.Color getOptionalBackgroundColor()
Gets the Optional background color property value.

Returns:
java.awt.Color - Optional background color.

getOptionalBackgroundColorString

public java.lang.String getOptionalBackgroundColorString()
Gets the Optional background color property value in a Java line code.

Returns:
String - Java line code.

getOptionalForegroundColor

public java.awt.Color getOptionalForegroundColor()
Gets the Optional foreground color property value.

Returns:
java.awt.Color - Optional foreground color.

getOptionalForegroundColorString

public java.lang.String getOptionalForegroundColorString()
Gets the Optional foreground color property value in a Java line code.

Returns:
String - Java line code.

getSelectionBackgroundColor

public java.awt.Color getSelectionBackgroundColor()
Gets the Selection background color property value.

Returns:
java.awt.Color - Selection background color.

getSelectionBackgroundColorString

public java.lang.String getSelectionBackgroundColorString()
Gets the Selection background color property value in a Java line code.

Returns:
String - Java line code.

getSelectionForegroundColor

public java.awt.Color getSelectionForegroundColor()
Gets the Selection foreground color property value.

Returns:
java.awt.Color - Selection foreground color.

getSelectionForegroundColorString

public java.lang.String getSelectionForegroundColorString()
Gets the Selection foreground color property value in a Java line code.

Returns:
String - Java line code.

getTypeComponent

public int getTypeComponent()
Gets the Type component property value.

Returns:
int - Type component.

newCopy

public ColorSettings newCopy()
returns a copy of this object.

Returns:
com.ibm.dse.gui.ColorSettings

setCaretColor

public void setCaretColor(java.awt.Color c)
Sets the Caret color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getCaretColor()

setErrorBackgroundColor

public void setErrorBackgroundColor(java.awt.Color c)
Sets the Error background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getErrorBackgroundColor()

setErrorForegroundColor

public void setErrorForegroundColor(java.awt.Color c)
Sets the Error foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getErrorForegroundColor()

setMandatoryBackgroundColor

public void setMandatoryBackgroundColor(java.awt.Color c)
Sets the Mandatory background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getMandatoryBackgroundColor()

setMandatoryForegroundColor

public void setMandatoryForegroundColor(java.awt.Color c)
Sets the Mandatory foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getMandatoryForegroundColor()

setNonEditableBackgroundColor

public void setNonEditableBackgroundColor(java.awt.Color c)
Sets the Non editable background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getNonEditableBackgroundColor()

setNonEditableForegroundColor

public void setNonEditableForegroundColor(java.awt.Color c)
Sets the Non editable foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getNonEditableForegroundColor()

setNonEnabledBackgroundColor

public void setNonEnabledBackgroundColor(java.awt.Color c)
Sets the Non Enabled background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
#getEnabledBackgroundColor

setNonEnabledForegroundColor

public void setNonEnabledForegroundColor(java.awt.Color c)
Sets the Non enabled foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getNonEnabledForegroundColor()

setOptionalBackgroundColor

public void setOptionalBackgroundColor(java.awt.Color c)
Sets the Optional background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getOptionalBackgroundColor()

setOptionalForegroundColor

public void setOptionalForegroundColor(java.awt.Color c)
Sets the Optional foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getOptionalForegroundColor()

setSelectionBackgroundColor

public void setSelectionBackgroundColor(java.awt.Color c)
Sets the Selection background color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getSelectionBackgroundColor()

setSelectionForegroundColor

public void setSelectionForegroundColor(java.awt.Color c)
Sets the Selection foreground color property (java.awt.color) value.

Parameters:
c - java.awt.Color, the new value for the property.
See Also:
getSelectionForegroundColor()

setTypeComponent

public void setTypeComponent(int typeCompo)
Sets the Type Component property value.

Parameters:
typeCompo - int, the new value for the property.
See Also:
getTypeComponent()

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005