fds.micro.ui
Class Hyperlink

java.lang.Object
  fds.micro.ui.Component
      fds.micro.ui.Hyperlink

public class Hyperlink

extends Component

This class implements a simple hyperlink without special visual effect when activated.
An object of this class is dedicated to be used within an object of fds.micro.ui.AbstractPanel sub-class (J2ME).

Warning: Use this class only if you want to have control on rendering. If possible, always prefer javax.microedition.lcdui.Item sub-classes.

You can read below a typical use within a class that inherit fds.micro.ui.RowPanel:

 ...
 this.append(new StringItem("Clic "));
 
 final Hyperlink link = new Hyperlink("here");
 link.addActionListener(
     new ActionListener() {
         public void actionPerformed(ActionEvent evt) {
             // Link activated: Go to next screen
             Display.getDisplay(this.midlet).setCurrent(myNextScreen);
         }
     }
 );
 this.append(link);
 
 this.append(new StringItem(" to continue."));
 ...
 

Author:

Frédéric DE STEUR

Field Summary

Fields inherited from class fds.micro.ui.Component

INTERN_BOTTOM_VALIGN, INTERN_CENTER_HALIGN, INTERN_CENTER_VALIGN, INTERN_LEFT_HALIGN, INTERN_RIGHT_HALIGN, INTERN_TOP_VALIGN

Constructor Summary

Hyperlink(java.lang.String text)
Build a button with a text inside.

Method Summary

void	activateLink() Activate the hyperlink.
void	addActionListener(ActionListener listener) Add a listener object that will receive action events produced by this component.
java.lang.String	getActionCommand() Get the command associated with the hyperlink activation.
java.lang.String	getText() Get the hyperlink text.
javax.microedition.lcdui.Font	getTextFont() Get the font used to display the hyperlink text.
void	keyPressed(int keyCode, int gameAction) Called to notify the component that a key is pressed.
void	pointerPressed(int xpos, int ypos) Called to notify the component that pointer device was pressed.
void	removeActionListener(ActionListener listener) Remove a listener.
void	setActionCommand(java.lang.String actionCommand) Set a command string that will be associated with the hyperlink activation.
void	setMaximumSize(int width, int height) Set the maximum size for this component.
void	setText(java.lang.String text) Change the hyperlink text.
void	setTextColor(int red, int green, int blue) Set the button text color.
void	setTextColorOff(int red, int green, int blue) Set the button text color used if the button is disabled.
void	setTextFont(javax.microedition.lcdui.Font textFont) Change the font used to display the hyperlink text.
void	setUnderlineColor(int red, int green, int blue) Set the underline color.

Methods inherited from class fds.micro.ui.Component

addFocusListener, addItemListener, equals, getHAlign, getHeight, getParent, getVAlign, getWidth, getX, getY, isDisabled, isHaveFocus, isHidden, isManageFocus, isOpaque, removeFocusListener, removeItemListener, setBackground, setDisabled, setFocusColor, setHAlign, setHidden, setLocation, setManageFocus, setOpaque, setVAlign

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Hyperlink

public Hyperlink(java.lang.String text)

Build a button with a text inside.

Parameters:

text - The text to display in the button

Method Detail

activateLink

public void activateLink()

Activate the hyperlink.

addActionListener

public void addActionListener(ActionListener listener)

Add a listener object that will receive action events produced by this component.

Parameters:

listener - The listener to add.

getActionCommand

public java.lang.String getActionCommand()

Get the command associated with the hyperlink activation.

Returns:

Returns the action command string.

getText

public java.lang.String getText()

Get the hyperlink text.

Returns:

Returns the text displayed.

getTextFont

public javax.microedition.lcdui.Font getTextFont()

Get the font used to display the hyperlink text.

Returns:

Returns the hyperlink font.

keyPressed

public void keyPressed(int keyCode,
                       int gameAction)

Called to notify the component that a key is pressed.

Specified by:

keyPressed in class Component

Parameters:

keyCode - The key code.

gameAction - Game action corresponding to the key code.

pointerPressed

public void pointerPressed(int xpos,
                           int ypos)

Called to notify the component that pointer device was pressed.

Specified by:

pointerPressed in class Component

Parameters:

xpos - The X position of pointer on parent Canvas.

ypos - The Y position of pointer on parent Canvas.

removeActionListener

public void removeActionListener(ActionListener listener)

Remove a listener.

Parameters:

listener - The listener to remove.

setActionCommand

public void setActionCommand(java.lang.String actionCommand)

Set a command string that will be associated with the hyperlink activation.

Parameters:

actionCommand - The action command to set.

setMaximumSize

public void setMaximumSize(int width,
                           int height)

Set the maximum size for this component.

Overrides:

setMaximumSize in class Component

Parameters:

width - The maximum width.

height - The maximum height.

setText

public void setText(java.lang.String text)

Change the hyperlink text.

Parameters:

text - The new text to display.

setTextColor

public void setTextColor(int red,
                         int green,
                         int blue)

Set the button text color.

Parameters:

red - The red component of the color to set.

green - The green component of the color to set.

blue - The blue component of the color to set.

setTextColorOff

public void setTextColorOff(int red,
                            int green,
                            int blue)

Set the button text color used if the button is disabled.

Parameters:

red - The red component of the color to set.

green - The green component of the color to set.

blue - The blue component of the color to set.

setTextFont

public void setTextFont(javax.microedition.lcdui.Font textFont)

Change the font used to display the hyperlink text.

Parameters:

textFont - The hyperlink font.

setUnderlineColor

public void setUnderlineColor(int red,
                              int green,
                              int blue)

Set the underline color.

Parameters:

red - The red component of the color to set.

green - The green component of the color to set.

blue - The blue component of the color to set.