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

All Superinterfaces:
SCButton, SCCustomComponent, SCImage

public interface SCWebLink
extends SCButton, SCImage

An SCWebLink is a specialized button with the look and feel of a web browser weblink which will launch URLs. It can be set up in the Screen Customizer Studio to look like a hypertext link.


Fields inherited from interface com.ibm.hi.customizer.beans.scci.SCButton
BALL, DYNAMIC, LABEL, STANDARD
 
Fields inherited from interface com.ibm.hi.customizer.beans.scci.SCImage
BOTH, HORIZONTAL, NONE, TOFIT, VERTICAL
 
Method Summary
 java.awt.Color getMouseOverColor()
          Gets the mouse over color.
 int getStyle()
          Returns the display style for the component.
 java.awt.Color getVisitedColor()
          Gets the visited color.
 boolean isLaunchNewBrowser()
          Gets the launch new browser flag.
 boolean isVisited()
          Gets the visited flag.
 void setLaunchNewBrowser(boolean newBrowser)
          Sets launch new browser flag.
 void setMouseOverColor(java.awt.Color color)
          Sets the mouseover color.
 void setStyle(int style)
          Sets the display style for the component.
 void setVisited(boolean visited)
          Sets the visited flag.
 void setVisitedColor(java.awt.Color color)
          Sets the visited color.
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCButton
doClick, getMacro, isTransparent, isUnderlined, setMacro, setTransparent, setUnderlined
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCCustomComponent
getBackgroundColor, getCaption, getForegroundColor, getGlobalRead, getGlobalWrite, getHelpCaption, getHostLinkLength, getHostLinkPosition, getTabNumber, hasFocus, isTempHidden, isVisible, readGlobalVariable, requestFocus, setBackgroundColor, setCaption, setForegroundColor, setGlobalRead, setGlobalWrite, setHelpCaption, setTempHidden, setVisible, toString, writeGlobalVariable
 
Methods inherited from interface com.ibm.hi.customizer.beans.scci.SCImage
getDisplayImage, getImage, getImageFileName, getLayoutType, setImage, setImage, setImageFileName, setImageFileName, setLayoutType
 

Method Detail

setStyle

public void setStyle(int style)
Sets the display style for the component.
Parameters:
style - the display style. Use LABEL for a web link that looks like a label, STANDARD for a normal button, and DYNAMIC for a dynamic, roll-over button.
See Also:
SCButton.LABEL, SCButton.STANDARD, SCButton.DYNAMIC

getStyle

public int getStyle()
Returns the display style for the component.
Returns:
the display style
See Also:
setStyle(int)

setVisited

public void setVisited(boolean visited)
Sets the visited flag.
Parameters:
visited - whether this SCWeblink has been visited
See Also:
isVisited()

isVisited

public boolean isVisited()
Gets the visited flag.
Returns:
true if the weblink has been visited; false otherwise
See Also:
setVisited(boolean)

setVisitedColor

public void setVisitedColor(java.awt.Color color)
Sets the visited color.
Parameters:
color - the visited color
See Also:
getVisitedColor()

getVisitedColor

public java.awt.Color getVisitedColor()
Gets the visited color.
Returns:
the visited color

setMouseOverColor

public void setMouseOverColor(java.awt.Color color)
Sets the mouseover color. When the mouse is moved over the weblink, the color will change to use the mouseover color.
Parameters:
color - the mouse over color
See Also:
getMouseOverColor()

getMouseOverColor

public java.awt.Color getMouseOverColor()
Gets the mouse over color.
Returns:
the mouseover color
See Also:
setMouseOverColor(java.awt.Color)

setLaunchNewBrowser

public void setLaunchNewBrowser(boolean newBrowser)
Sets launch new browser flag. If the flag is true the SCWebLink will open a new browser window when opening a webpage; otherwise, the webpage will be opened in the same browser window.
Parameters:
newBrowser - the new browser flag
See Also:
isLaunchNewBrowser()

isLaunchNewBrowser

public boolean isLaunchNewBrowser()
Gets the launch new browser flag.
Returns:
the launch new browser flag
See Also:
setLaunchNewBrowser(boolean)