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
-
getBackgroundColor()
- Gets the background color.
-
getCaption()
- Gets the displayed caption.
-
getForegroundColor()
- Gets the foreground color.
-
getGlobalRead()
- Gets the global variable the component reads from.
-
getGlobalWrite()
- Gets the global variable the component writes to.
-
getHelpCaption()
- Gets the help caption.
-
getHostLinkLength()
- Gets the host-link length.
-
getHostLinkPosition()
- Gets the host-link position.
-
getTabNumber()
- Gets the tab number.
-
hasFocus()
- Determines if this component has focus or not.
-
isVisible()
- Gets the visibility of this component.
-
readGlobalVariable()
- Sets the component's value to be that of its
associated global read variable.
-
requestFocus()
- Sends a request focus to the component.
-
setBackgroundColor(Color)
- Sets the background color.
-
setCaption(String)
- Sets the displayed caption.
-
setForegroundColor(Color)
- Sets the foreground color.
-
setGlobalRead(String)
- Sets the global variable the component reads from.
-
setGlobalWrite(String)
- Sets the global variable the component writes to.
-
setHelpCaption(String)
- Sets the help text to be displayed in the status bar on a mouseover.
-
setVisible(boolean)
- Sets visibililty of this component.
-
toString()
- Gets a descriptive string.
-
writeGlobalVariable()
- Writes the component's current value to its
global write variable.
toString
public abstract String toString()
- Gets a descriptive string.
- Returns:
- a descriptive string
- Overrides:
- toString in class Object
setCaption
public abstract void setCaption(String caption)
- Sets the displayed caption.
- Parameters:
-
caption
- the caption to set.
- See Also:
- getCaption
getCaption
public abstract String getCaption()
- Gets the displayed caption.
- Returns:
- the displayed caption
- See Also:
- setCaption
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
getHelpCaption
public abstract String getHelpCaption()
- Gets the help caption.
- Returns:
- the help caption
- See Also:
- setHelpCaption
getGlobalRead
public abstract String getGlobalRead()
- Gets the global variable the component reads from.
- Returns:
- the global variable the component reads from
setGlobalRead
public abstract void setGlobalRead(String var)
- Sets the global variable the component reads from.
- Parameters:
-
var
- the variable name
getGlobalWrite
public abstract String getGlobalWrite()
- Gets the global variable the component writes to.
- Returns:
- the global variable the component writes to
setGlobalWrite
public abstract void setGlobalWrite(String var)
- Sets the global variable the component writes to.
- Parameters:
-
var
- the variable name
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.
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.
setForegroundColor
public abstract void setForegroundColor(Color c)
- Sets the foreground color.
- Parameters:
-
c
- the foreground color to set
- See Also:
- getForegroundColor, setBackgroundColor
getForegroundColor
public abstract Color getForegroundColor()
- Gets the foreground color.
- Returns:
- the foreground color
- See Also:
- setForegroundColor, getBackgroundColor
setBackgroundColor
public abstract void setBackgroundColor(Color c)
- Sets the background color.
- Parameters:
-
c
- the background color to set
- See Also:
- getBackgroundColor, setForegroundColor
getBackgroundColor
public abstract Color getBackgroundColor()
- Gets the background color.
- Returns:
- the background color
- See Also:
- setBackgroundColor, getForegroundColor
requestFocus
public abstract void requestFocus()
- Sends a request focus to the component.
- See Also:
- hasFocus
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
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
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
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
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
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