com.ibm.hi.customizer.beans.scci
Interface SCCustomComponent

All Known Subinterfaces:
SCBall, SCButton, SCButtonVV, SCCheckbox, SCChoice, SCFrame, SCHostList, SCImage, SCImageButton, SCLabel, SCList, SCRadioButton, SCSelection, SCSelectionList, SCTextComponent, SCTextfield, SCWebLink

public interface SCCustomComponent

SCCustomComponent is the ultimate base of all Screen Customizer (SC) components.

See Also:
SCFrame, SCTextComponent, SCButton, SCImage, SCCheckbox, SCSelection

Method Summary
 java.awt.Color getBackgroundColor()
          Gets the background color.
 java.lang.String getCaption()
          Gets the displayed caption.
 java.awt.Color getForegroundColor()
          Gets the foreground color.
 java.lang.String getGlobalRead()
          Gets the global variable the component reads from.
 java.lang.String getGlobalWrite()
          Gets the global variable the component writes to.
 java.lang.String getHelpCaption()
          Gets the help caption.
 int getHostLinkLength()
          Gets the host-link length.
 int getHostLinkPosition()
          Gets the host-link position.
 int getTabNumber()
          Gets the tab number.
 boolean hasFocus()
          Determines if this component has focus or not.
 boolean isTempHidden()
          Gets the value of temporary hidden fields
 boolean isVisible()
          Gets the visibility of this component.
 void readGlobalVariable()
          Sets the component's value to be that of its associated global read variable.
 void requestFocus()
          Sends a request focus to the component.
 void setBackgroundColor(java.awt.Color c)
          Sets the background color.
 void setCaption(java.lang.String caption)
          Sets the displayed caption.
 void setForegroundColor(java.awt.Color c)
          Sets the foreground color.
 void setGlobalRead(java.lang.String var)
          Sets the global variable the component reads from.
 void setGlobalWrite(java.lang.String var)
          Sets the global variable the component writes to.
 void setHelpCaption(java.lang.String helpCaption)
          Sets the help text to be displayed in the status bar on a mouseover.
 void setTempHidden(boolean b)
          Sets visibililty of this Hidden component.
 void setVisible(boolean b)
          Sets visibililty of this component.
 java.lang.String toString()
          Gets a descriptive string.
 void writeGlobalVariable()
          Writes the component's current value to its global write variable.
 

Method Detail

toString

public java.lang.String toString()
Gets a descriptive string.
Overrides:
toString in class java.lang.Object
Returns:
a descriptive string

setCaption

public void setCaption(java.lang.String caption)
Sets the displayed caption.
Parameters:
caption - the caption to set.
See Also:
getCaption()

getCaption

public java.lang.String getCaption()
Gets the displayed caption.
Returns:
the displayed caption
See Also:
setCaption(java.lang.String)

setHelpCaption

public void setHelpCaption(java.lang.String helpCaption)
Sets the help text to be displayed in the status bar on a mouseover.
Parameters:
helpCaption - the help caption to set.
See Also:
getHelpCaption()

getHelpCaption

public java.lang.String getHelpCaption()
Gets the help caption.
Returns:
the help caption
See Also:
setHelpCaption(java.lang.String)

getGlobalRead

public java.lang.String getGlobalRead()
Gets the global variable the component reads from.
Returns:
the global variable the component reads from

setGlobalRead

public void setGlobalRead(java.lang.String var)
Sets the global variable the component reads from.
Parameters:
var - the variable name

getGlobalWrite

public java.lang.String getGlobalWrite()
Gets the global variable the component writes to.
Returns:
the global variable the component writes to

setGlobalWrite

public void setGlobalWrite(java.lang.String var)
Sets the global variable the component writes to.
Parameters:
var - the variable name

writeGlobalVariable

public void writeGlobalVariable()
Writes the component's current value to its global write variable. If the component does not have an associated global write variable a call to this method does nothing.

readGlobalVariable

public void readGlobalVariable()
Sets the component's value to be that of its associated global read variable. If the component does not have an associated global read variable a call to this method does nothing.

setForegroundColor

public void setForegroundColor(java.awt.Color c)
Sets the foreground color.
Parameters:
c - the foreground color to set
See Also:
getForegroundColor(), setBackgroundColor(java.awt.Color)

getForegroundColor

public java.awt.Color getForegroundColor()
Gets the foreground color.
Returns:
the foreground color
See Also:
setForegroundColor(java.awt.Color), getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(java.awt.Color c)
Sets the background color.
Parameters:
c - the background color to set
See Also:
getBackgroundColor(), setForegroundColor(java.awt.Color)

getBackgroundColor

public java.awt.Color getBackgroundColor()
Gets the background color.
Returns:
the background color
See Also:
setBackgroundColor(java.awt.Color), getForegroundColor()

requestFocus

public void requestFocus()
Sends a request focus to the component.
See Also:
hasFocus()

hasFocus

public boolean hasFocus()
Determines if this component has focus or not.
Returns:
true if this component has focus
false if this component does not have focus
See Also:
requestFocus()

setVisible

public void setVisible(boolean b)
Sets visibililty of this component.
Parameters:
b - a value of true will show the component;
a value of false will hide it.
See Also:
isVisible()

isVisible

public boolean isVisible()
Gets the visibility of this component.
Returns:
true if the component is visible, or
false if the component is not visible

setTempHidden

public void setTempHidden(boolean b)
Sets visibililty of this Hidden component.
Parameters:
b - a value of true will hide the component;
a value of false will show it.
See Also:
isVisible()

isTempHidden

public boolean isTempHidden()
Gets the value of temporary hidden fields
Returns:
true if the component is hidden, or
false if the component is not hidden

getTabNumber

public int getTabNumber()
Gets the tab number. All active components have a tab number associated with them to direct focus to the proper component when the TAB key is pressed. Focus will go the component with the next highest tab number, and if there is no higher tab number, it will go the the component with the lowest tab number.
Returns:
the tab number associated with this component

getHostLinkPosition

public int getHostLinkPosition()
Gets the host-link position.
Returns:
the host-linked field position,
or -1 if there is no host-linked field

getHostLinkLength

public int getHostLinkLength()
Gets the host-link length.
Returns:
the host-linked field length,
or -1 if there is no host-linked field