SuperLabel (Oracle Fusion Middleware Java API Reference for Oracle Extension SDK)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SuperLabel.HyperlinkRun
Class to hold the bounds (character positions) of a hyperlink, and it's value.
- Nested classes/interfaces inherited from class javax.swing.JLabel
  javax.swing.JLabel.AccessibleJLabel
- Nested classes/interfaces inherited from class javax.swing.JComponent
  javax.swing.JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SuperLabel.HyperlinkRun` Class to hold the bounds (character positions) of a hyperlink, and it's value.

Field Summary

Fields
Modifier and Type Field and Description

static int ACTION_HYPERLINK
ID for the action indicating that a hyperlink was clicked.
- Fields inherited from class javax.swing.JLabel
  labelFor
- Fields inherited from class javax.swing.JComponent
  listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface javax.swing.SwingConstants
  BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields
Modifier and Type	Field and Description
`static int`	`ACTION_HYPERLINK` ID for the action indicating that a hyperlink was clicked.

Constructor Summary

Constructors
Constructor and Description

SuperLabel()

SuperLabel(java.text.AttributedString attributedstring)

SuperLabel(java.lang.String text)

Constructors
Constructor and Description
`SuperLabel()`
`SuperLabel(java.text.AttributedString attributedstring)`
`SuperLabel(java.lang.String text)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addActionListener(java.awt.event.ActionListener al)` Add a listener to receive events such as hyperlink clicks.
`void`	`addHyperlink(int firstIndex, int lastIndex, java.lang.String value)` Add a hyperlink to the given indexes (inclusive).
`void`	`fireActionEvent(int id, java.lang.String command)`
`java.text.AttributedString`	`getAttributedText()`
`java.awt.Color`	`getHyperlinkForeground()`
`java.util.List<SuperLabel.HyperlinkRun>`	`getHyperlinkRuns()`
`int`	`getPreferredWrapWidth()`
`java.lang.String`	`getText()`
`boolean`	`isLabelOverride()`
`boolean`	`isPaintHyperlink()`
`boolean`	`isRequireModifierForHyperlink()`
`static void`	`main(java.lang.String[] args)` Main method for testing purposes.
`void`	`removeActionListener(java.awt.event.ActionListener al)`
`void`	`setAttributedText(java.text.AttributedString aText)`
`void`	`setDisabledIcon(javax.swing.Icon disabledIcon)` Deprecated.
`void`	`setDisplayedMnemonic(int key)`
`void`	`setDisplayedMnemonicIndex(int index)`
`void`	`setFont(java.awt.Font font)` Sets the font for this label.
`void`	`setHyperlinkForeground(java.awt.Color hyperlinkForeground)` Change the foreground color used to render hyperlinks.
`void`	`setIcon(javax.swing.Icon icon)` Deprecated.
`void`	`setLabelOverride(boolean useFontOverride)` By default the SuperLabel will use only the font attributes set on the given AttributedString.
`void`	`setPaintHyperlink(boolean paintHyperlink)`
`void`	`setPreferredWrapWidth(int preferredWidth)` Set the preferred wrap width (in pixels).
`void`	`setRequireModifierForHyperlink(boolean requireModifierForHyperlink)` If true, then the user will be required to hold down a modifier key, such as the control key, to navigate hyperlinks.
`void`	`setText(java.lang.String string)`
`void`	`setUI(javax.swing.plaf.LabelUI labelUI)`

Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisplayedMnemonic, setHorizontalAlignment, setHorizontalTextPosition, setIconTextGap, setLabelFor, setVerticalAlignment, setVerticalTextPosition, updateUI

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACTION_HYPERLINK
```
public static final int ACTION_HYPERLINK
```
    ID for the action indicating that a hyperlink was clicked. The ActionEvent that has this id will contain as it's command the SuperTextAttribute.HYPERLINK's value for the clicked text.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SuperLabel
```
public SuperLabel()
```
  - SuperLabel
```
public SuperLabel(java.text.AttributedString attributedstring)
```
  - SuperLabel
```
public SuperLabel(java.lang.String text)
```
- Method Detail
  - addActionListener
```
public void addActionListener(java.awt.event.ActionListener al)
```
    Add a listener to receive events such as hyperlink clicks.
    
    Parameters:
    
    al -
  - removeActionListener
```
public void removeActionListener(java.awt.event.ActionListener al)
```
  - addHyperlink
```
public void addHyperlink(int firstIndex,
                         int lastIndex,
                         java.lang.String value)
```
    Add a hyperlink to the given indexes (inclusive). The value will be returned as an action command to registered ActionListeners when the user clicks on the hyperlink.
    Note: The hyperlink will be removed if the text of the SuperLabel changes.
    
    Parameters:
    
    firstIndex - first character index of the hyperlink
    
    lastIndex - last character index of the hyperlink
    
    value - a String token that will be returned as the ActionEvent command when link is clicked.
  - fireActionEvent
```
public void fireActionEvent(int id,
                            java.lang.String command)
```
  - setPreferredWrapWidth
```
public void setPreferredWrapWidth(int preferredWidth)
```
    Set the preferred wrap width (in pixels). If the text is longer than this limit then it will try to wrap onto the next line. If the text is shorter than the preferred wrap width then the text will all appear on one line and the component will prefer to size to this text size to this text.
    By default the label will attempt to put all of the text onto one line.
    
    Parameters:
    
    preferredWidth -
  - getPreferredWrapWidth
```
public int getPreferredWrapWidth()
```
  - setUI
```
public void setUI(javax.swing.plaf.LabelUI labelUI)
```
    Overrides:
    
    setUI in class javax.swing.JLabel
  - setAttributedText
```
public void setAttributedText(java.text.AttributedString aText)
```
  - getAttributedText
```
public java.text.AttributedString getAttributedText()
```
  - setText
```
public void setText(java.lang.String string)
```
    Overrides:
    
    setText in class javax.swing.JLabel
  - getText
```
public java.lang.String getText()
```
    Overrides:
    
    getText in class javax.swing.JLabel
  - setDisplayedMnemonicIndex
```
public void setDisplayedMnemonicIndex(int index)
                               throws java.lang.IllegalArgumentException
```
    Overrides:
    
    setDisplayedMnemonicIndex in class javax.swing.JLabel
    
    Throws:
    
    java.lang.IllegalArgumentException
  - setDisplayedMnemonic
```
public void setDisplayedMnemonic(int key)
```
    Overrides:
    
    setDisplayedMnemonic in class javax.swing.JLabel
  - setDisabledIcon
```
@Deprecated
public void setDisabledIcon(javax.swing.Icon disabledIcon)
```
    Deprecated.
    
    Icons are not supported by SuperLabel. A call to this method will not fail, but no icon will be displayed in the label.
    
    Overrides:
    
    setDisabledIcon in class javax.swing.JLabel
    
    Parameters:
    
    disabledIcon -
  - setIcon
```
@Deprecated
public void setIcon(javax.swing.Icon icon)
```
    Deprecated.
    
    Icons are not supported by SuperLabel. A call to this method will not fail, but no icon will be displayed in the label.
    
    Overrides:
    
    setIcon in class javax.swing.JLabel
    
    Parameters:
    
    icon -
  - setFont
```
public void setFont(java.awt.Font font)
```
    Sets the font for this label. This font will only be used if setLabelOverride() has been called with true, otherwise the font specified on the AttributedString will be used.
    
    Overrides:
    
    setFont in class javax.swing.JComponent
    
    Parameters:
    
    font -
  - setLabelOverride
```
public void setLabelOverride(boolean useFontOverride)
```
    By default the SuperLabel will use only the font attributes set on the given AttributedString. Calls to setFont() will be ignored unless this this method is called with true. In that case the supplied font will be used for the whole label.
    
    Parameters:
    
    useFontOverride - call with true to use the font from setFont().
  - isLabelOverride
```
public boolean isLabelOverride()
```
  - main
```
public static void main(java.lang.String[] args)
```
    Main method for testing purposes. Do not call outside of testing.
    
    Parameters:
    
    args -
  - setHyperlinkForeground
```
public void setHyperlinkForeground(java.awt.Color hyperlinkForeground)
```
    Change the foreground color used to render hyperlinks.
    
    Parameters:
    
    hyperlinkForeground -
  - getHyperlinkForeground
```
public java.awt.Color getHyperlinkForeground()
```
  - getHyperlinkRuns
```
public java.util.List<SuperLabel.HyperlinkRun> getHyperlinkRuns()
```
    Returns:
    
    an unmodifiable list of HyperlinkRuns, which indicate where in the label there are hyperlinks.
  - setRequireModifierForHyperlink
```
public void setRequireModifierForHyperlink(boolean requireModifierForHyperlink)
```
    If true, then the user will be required to hold down a modifier key, such as the control key, to navigate hyperlinks. Defaults to false.
    
    Parameters:
    
    requireModifierForHyperlink -
  - isRequireModifierForHyperlink
```
public boolean isRequireModifierForHyperlink()
```
  - setPaintHyperlink
```
public void setPaintHyperlink(boolean paintHyperlink)
```
  - isPaintHyperlink
```
public boolean isPaintHyperlink()
```

Class SuperLabel

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JLabel

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JLabel

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface javax.swing.SwingConstants

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JLabel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

ACTION_HYPERLINK

Constructor Detail

SuperLabel

SuperLabel

SuperLabel

Method Detail

addActionListener

removeActionListener

addHyperlink

fireActionEvent

setPreferredWrapWidth

getPreferredWrapWidth

setUI

setAttributedText

getAttributedText

setText

getText

setDisplayedMnemonicIndex

setDisplayedMnemonic

setDisabledIcon

setIcon

setFont

setLabelOverride

isLabelOverride

main

setHyperlinkForeground

getHyperlinkForeground

getHyperlinkRuns

setRequireModifierForHyperlink

isRequireModifierForHyperlink

setPaintHyperlink

isPaintHyperlink