JavaFX 24 · javafx.scene.control.Hyperlink · APIdia, the JavaDoc alternative

An HTML like label which can be a graphic and/or text which responds to rollovers and clicks. When a hyperlink is clicked/pressed isVisited becomes true. A Hyperlink behaves just like a Button. When a hyperlink is pressed and released a ActionEvent is sent, and your application can perform some action based on this event.

Example:

Hyperlink link = new Hyperlink("www.oracle.com");

Field Summary

Modifier and Type	Field and Description
private static final String	DEFAULT_STYLE_CLASS
private static final PseudoClass	PSEUDO_CLASS_VISITED
private BooleanProperty	visited

Constructor Summary

Access	Constructor and Description
public	Hyperlink() Creates a hyperlink with no label.
public	Hyperlink(String A text string for its label. text) Create a hyperlink with the specified text as its label.
public	Hyperlink(String A text string for its label. text, Node A graphic for its label graphic) Create a hyperlink with the specified text and graphic as its label.

Method Summary

Modifier and Type	Method and Description
protected Skin<?>	createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control.
public void	fire() Implements abstract javafx.scene.control.ButtonBase.fire. Implemented to invoke the `ActionEvent` if one is defined.
protected Cursor	getInitialCursor() Overrides javafx.scene.Node.getInitialCursor. Returns the initial cursor state of this control, for use by the JavaFX CSS engine to correctly set its initial value.
private void	initialize()
public final boolean	isVisited()
public Object	queryAccessibleAttribute(AccessibleAttribute the requested attribute attribute, Object... optional list of parameters parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute.
public final void	setVisited(boolean value)
public final BooleanProperty	Returns: true if this link has already been "visited" visitedProperty() Indicates whether this link has already been "visited".

Inherited from javafx.scene.control.ButtonBase:: arm armedProperty disarm executeAccessibleAction getOnAction isArmed onActionProperty setOnAction

Field Detail

DEFAULT_STYLE_CLASS	back to summary
private static final String DEFAULT_STYLE_CLASS

PSEUDO_CLASS_VISITED	back to summary
private static final PseudoClass PSEUDO_CLASS_VISITED

visited	back to summary
private BooleanProperty visited

Constructor Detail

Hyperlink	back to summary
public Hyperlink() Creates a hyperlink with no label.

Hyperlink	back to summary
public Hyperlink(String text) Create a hyperlink with the specified text as its label. Parameters text:String A text string for its label.

Hyperlink

back to summary

public Hyperlink(String text)

Create a hyperlink with the specified text as its label.

Parameters

text:String: A text string for its label.

Hyperlink	back to summary
public Hyperlink(String text, Node graphic) Create a hyperlink with the specified text and graphic as its label. Parameters text:String A text string for its label. graphic:Node A graphic for its label

Hyperlink

back to summary

public Hyperlink(String text, Node graphic)

Create a hyperlink with the specified text and graphic as its label.

Parameters

text:String: A text string for its label.
graphic:Node: A graphic for its label

Method Detail

createDefaultSkin back to summary

createDefaultSkin	back to summary
protected Skin<?> createDefaultSkin() Overrides javafx.scene.control.Control.createDefaultSkin. Doc from javafx.scene.control.Control.createDefaultSkin. Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS `-fx-skin` or set explicitly in a sub-class with `setSkin(...)`. Returns:Skin<?> new instance of default skin for this control. If null then the control will have no skin unless one is provided by css. Annotations @Override

protected Skin<?> createDefaultSkin()

Overrides javafx.scene.control.Control.createDefaultSkin.

Doc from javafx.scene.control.Control.createDefaultSkin.

Create a new instance of the default skin for this control. This is called to create a skin for the control if no skin is provided via CSS -fx-skin or set explicitly in a sub-class with setSkin(...).

Returns:Skin<?>

new instance of default skin for this control. If null then the control will have no skin unless one is provided by css.

Annotations

@Override

fire back to summary

fire	back to summary
public void fire() Implements abstract javafx.scene.control.ButtonBase.fire. Implemented to invoke the `ActionEvent` if one is defined. This function will also `setVisited` to true. Annotations @Override

public void fire()

Implements abstract javafx.scene.control.ButtonBase.fire.

Implemented to invoke the ActionEvent if one is defined. This function will also setVisited to true.

Annotations

@Override

getInitialCursor back to summary

getInitialCursor	back to summary
protected Cursor getInitialCursor() Overrides javafx.scene.Node.getInitialCursor. Returns the initial cursor state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden to use the HAND cursor initially. Returns:Cursor Doc from javafx.scene.Node.getInitialCursor. the initial cursor state for this `Node`. Annotations @Override Since 9

protected Cursor getInitialCursor()

Overrides javafx.scene.Node.getInitialCursor.

Returns the initial cursor state of this control, for use by the JavaFX CSS engine to correctly set its initial value. This method is overridden to use the HAND cursor initially.

Returns:Cursor

Doc from javafx.scene.Node.getInitialCursor.

the initial cursor state for this Node.

Annotations

@Override

Since

initialize	back to summary
private void initialize()

isVisited	back to summary
public final boolean isVisited()

queryAccessibleAttribute	back to summary
public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters) Overrides javafx.scene.control.Control.queryAccessibleAttribute. Doc from javafx.scene.control.Control.queryAccessibleAttribute. This method is called by the assistive technology to request the value for an attribute. This method is commonly overridden by subclasses to implement attributes that are required for a specific role. If a particular attribute is not handled, the superclass implementation must be called. Parameters attribute:AccessibleAttribute Doc from javafx.scene.Node.queryAccessibleAttribute. the requested attribute parameters:Object[] Doc from javafx.scene.Node.queryAccessibleAttribute. optional list of parameters Returns:Object Doc from javafx.scene.Node.queryAccessibleAttribute. the value for the requested attribute Annotations @Override

queryAccessibleAttribute

back to summary

public Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

Overrides javafx.scene.control.Control.queryAccessibleAttribute.

Doc from javafx.scene.control.Control.queryAccessibleAttribute.

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

Parameters

attribute:AccessibleAttribute

Doc from javafx.scene.Node.queryAccessibleAttribute.

the requested attribute

parameters:Object[]

Doc from javafx.scene.Node.queryAccessibleAttribute.

optional list of parameters

Returns:Object

Doc from javafx.scene.Node.queryAccessibleAttribute.

the value for the requested attribute

Annotations

@Override

setVisited	back to summary
public final void setVisited(boolean value)

visitedProperty	back to summary
public final BooleanProperty visitedProperty() Indicates whether this link has already been "visited". Returns:BooleanProperty true if this link has already been "visited"

visitedProperty

back to summary

public final BooleanProperty visitedProperty()

Indicates whether this link has already been "visited".

Returns:BooleanProperty: true if this link has already been "visited"

public Class Hyperlink

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail