Class JXHyperlink

  • All Implemented Interfaces:
    ImageObserver, ItemSelectable, MenuContainer, Serializable, Accessible, SwingConstants
    Direct Known Subclasses:
    JXRendererHyperlink

    public class JXHyperlink
    extends JButton
    A hyperlink component that derives from JButton to provide compatibility mostly for binding actions enabled/disabled behavior accessibility i18n etc...

    This button has visual state related to a notion of "clicked": foreground color is unclickedColor or clickedColor depending on its boolean bound property clicked being false or true, respectively. If the hyperlink has an action, it guarantees to synchronize its "clicked" state to an action value with key LinkAction.VISITED_KEY. Synchronization happens on setAction() and on propertyChange notification from the action. JXHyperlink accepts any type of action - AbstractHyperlinkAction is a convenience implementation to simplify clicked control.

     
          LinkAction linkAction = new LinkAction("http://swinglabs.org") {
                public void actionPerformed(ActionEvent e) {
                    doSomething(getTarget());
                    setVisited(true);
                }
          };
          JXHyperlink hyperlink = new JXHyperlink(linkAction);
      
    The hyperlink can be configured to always update its clicked property after firing the actionPerformed:
     
          JXHyperlink hyperlink = new JXHyperlink(action);
          hyperlink.setOverrulesActionOnClick(true);
      
    By default, this property is false. The hyperlink will auto-click only if it has no action. Developers can change the behaviour by overriding isAutoSetClicked();
    Author:
    Richard Bair, Shai Almog, Jeanette Winzenburg
    See Also:
    Serialized Form
    • Constructor Detail

      • JXHyperlink

        public JXHyperlink()
        Creates a new instance of JXHyperlink with default parameters
      • JXHyperlink

        public JXHyperlink​(Action action)
        Creates a new instance of JHyperLink and configures it from provided Action.
        Parameters:
        action - Action whose parameters will be borrowed to configure newly created JXHyperLink
    • Method Detail

      • getUnclickedColor

        public Color getUnclickedColor()
        Returns the foreground color for unvisited links.
        Returns:
        Color for the hyper link if it has not yet been clicked.
      • setClickedColor

        public void setClickedColor​(Color color)
        Sets the color for the previously not visited link. This value will override the one set by the "JXHyperlink.unclickedColor" UIManager property and defaults.
        Parameters:
        color - Color for the hyper link if it has not yet been clicked.
      • getClickedColor

        public Color getClickedColor()
        Returns the foreground color for visited links.
        Returns:
        Color for the hyper link if it has already been clicked.
      • setUnclickedColor

        public void setUnclickedColor​(Color color)
        Sets the color for the previously visited link. This value will override the one set by the "JXHyperlink.clickedColor" UIManager property and defaults.
        Parameters:
        color - Color for the hyper link if it has already been clicked.
      • setClicked

        public void setClicked​(boolean clicked)
        Sets the clicked property and updates visual state depending on clicked. This implementation updated the foreground color.

        NOTE: as with all button's visual properties, this will not update the backing action's "visited" state.

        Parameters:
        clicked - flag to indicate if the button should be regarded as having been clicked or not.
        See Also:
        isClicked()
      • isClicked

        public boolean isClicked()
        Returns a boolean indicating if this link has already been visited.
        Returns:
        true if hyper link has already been clicked.
        See Also:
        setClicked(boolean)
      • setOverrulesActionOnClick

        public void setOverrulesActionOnClick​(boolean overrule)
        Sets the overrulesActionOnClick property. It controls whether this button should overrule the Action's visited property on actionPerformed.

        The default value is false.

        Parameters:
        overrule - if true, fireActionPerformed will set clicked to true independent of action.
        See Also:
        getOverrulesActionOnClick(), setClicked(boolean)
      • getOverrulesActionOnClick

        public boolean getOverrulesActionOnClick()
        Returns a boolean indicating whether the clicked property should be set always on clicked.
        Returns:
        overrulesActionOnClick false if his button clicked property respects the Action's visited property. True if the clicked should be updated on every actionPerformed.
        See Also:
        setOverrulesActionOnClick(boolean), setClicked(boolean)
      • isAutoSetClicked

        protected boolean isAutoSetClicked()
        Returns a boolean indicating whether the clicked property should be set after firing action events. Here: true if no action or overrulesAction property is true.
        Returns:
        true if fireActionEvent should force a clicked, false if not.
      • configurePropertiesFromAction

        protected void configurePropertiesFromAction​(Action a)
        Read all the essential properties from the provided Action and apply it to the JXHyperlink
        Overrides:
        configurePropertiesFromAction in class AbstractButton
      • getUIClassID

        public String getUIClassID()
        Returns a string that specifies the name of the L&F class that renders this component.
        Overrides:
        getUIClassID in class JButton
      • updateUI

        public void updateUI()
        Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.
        Overrides:
        updateUI in class JButton
        See Also:
        JComponent.updateUI()