All Packages  Class Hierarchy  This Package  Previous  Next  Index

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

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

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

Method Index

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

Methods

 o toString
 public abstract String toString()
Gets a descriptive string.

Returns:
a descriptive string
Overrides:
toString in class Object
 o setCaption
 public abstract void setCaption(String caption)
Sets the displayed caption.

Parameters:
caption - the caption to set.
See Also:
getCaption
 o getCaption
 public abstract String getCaption()
Gets the displayed caption.

Returns:
the displayed caption
See Also:
setCaption
 o setHelpCaption
 public abstract void setHelpCaption(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
 o getHelpCaption
 public abstract String getHelpCaption()
Gets the help caption.

Returns:
the help caption
See Also:
setHelpCaption
 o getGlobalRead
 public abstract String getGlobalRead()
Gets the global variable the component reads from.

Returns:
the global variable the component reads from
 o setGlobalRead
 public abstract void setGlobalRead(String var)
Sets the global variable the component reads from.

Parameters:
var - the variable name
 o getGlobalWrite
 public abstract String getGlobalWrite()
Gets the global variable the component writes to.

Returns:
the global variable the component writes to
 o setGlobalWrite
 public abstract void setGlobalWrite(String var)
Sets the global variable the component writes to.

Parameters:
var - the variable name
 o writeGlobalVariable
 public abstract 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.

 o readGlobalVariable
 public abstract 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.

 o setForegroundColor
 public abstract void setForegroundColor(Color c)
Sets the foreground color.

Parameters:
c - the foreground color to set
See Also:
getForegroundColor, setBackgroundColor
 o getForegroundColor
 public abstract Color getForegroundColor()
Gets the foreground color.

Returns:
the foreground color
See Also:
setForegroundColor, getBackgroundColor
 o setBackgroundColor
 public abstract void setBackgroundColor(Color c)
Sets the background color.

Parameters:
c - the background color to set
See Also:
getBackgroundColor, setForegroundColor
 o getBackgroundColor
 public abstract Color getBackgroundColor()
Gets the background color.

Returns:
the background color
See Also:
setBackgroundColor, getForegroundColor
 o requestFocus
 public abstract void requestFocus()
Sends a request focus to the component.

See Also:
hasFocus
 o hasFocus
 public abstract 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
 o setVisible
 public abstract 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
 o isVisible
 public abstract boolean isVisible()
Gets the visibility of this component.

Returns:
true if the component is visible, or false if the component is not visible
 o getTabNumber
 public abstract 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
 o getHostLinkPosition
 public abstract int getHostLinkPosition()
Gets the host-link position.

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

Returns:
the host-linked field length, or -1 if there is no host-linked field

All Packages  Class Hierarchy  This Package  Previous  Next  Index