Package io.guise.framework.component

Class HeadingLink

java.lang.Object

com.globalmentor.beans.BoundPropertyObject

io.guise.framework.event.GuiseBoundPropertyObject

io.guise.framework.model.ui.AbstractPresentationModel

io.guise.framework.component.AbstractComponent

io.guise.framework.component.AbstractControl

io.guise.framework.component.AbstractActionControl

io.guise.framework.component.AbstractLinkControl

io.guise.framework.component.HeadingLink

All Implemented Interfaces:

com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable, ActionControl, Component, Control, HeadingComponent, InputFocusableComponent, LabelComponent, LabelDisplayableComponent, LinkControl, ActionListenable, ActionModel, Displayable, Enableable, InfoModel, LabelModel, Model, PresentationModel, DepictedObject

public class HeadingLink
extends AbstractLinkControl
implements HeadingComponent

Control with an action model rendered as a heading link.

Author:

Garret Wilson

Nested Class Summary

Nested classes/interfaces inherited from class io.guise.framework.component.AbstractComponent

AbstractComponent.AbstractFlyoverFrameStrategy<S extends Component>, AbstractComponent.AbstractFlyoverStrategy<S extends Component>, AbstractComponent.DefaultFlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface io.guise.framework.component.Component

Component.FlyoverStrategy<S extends Component>

Nested classes/interfaces inherited from interface io.guise.framework.component.Control

Control.Status

Field Summary

Fields inherited from class com.globalmentor.beans.BoundPropertyObject

NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS

Fields inherited from interface io.guise.framework.component.ActionControl

ROLLOVER_PROPERTY

Fields inherited from interface io.guise.framework.component.Component

BOOKMARK_ENABLED_PROPERTY, CONSTRAINTS_PROPERTY, DRAG_ENABLED_PROPERTY, DROP_ENABLED_PROPERTY, FLYOVER_ENABLED_PROPERTY, FLYOVER_STRATEGY_PROPERTY, INPUT_STRATEGY_PROPERTY, NAME_PROPERTY, NOTIFICATION_PROPERTY, ORIENTATION_PROPERTY, THEME_APPLIED_PROPERTY, VALID_PROPERTY

Fields inherited from interface io.guise.framework.component.Control

STATUS_PROPERTY

Fields inherited from interface io.guise.framework.model.Displayable

DISPLAYED_PROPERTY

Fields inherited from interface io.guise.framework.model.Enableable

ENABLED_PROPERTY

Fields inherited from interface io.guise.framework.component.HeadingComponent

LEVEL_PROPERTY, NO_HEADING_LEVEL

Fields inherited from interface io.guise.framework.model.InfoModel

DESCRIPTION_CONTENT_TYPE_PROPERTY, DESCRIPTION_PROPERTY, INFO_CONTENT_TYPE_PROPERTY, INFO_PROPERTY

Fields inherited from interface io.guise.framework.component.LabelDisplayableComponent

ICON_DISPLAYED_PROPERTY, LABEL_DISPLAYED_PROPERTY

Fields inherited from interface io.guise.framework.model.LabelModel

GLYPH_URI_PROPERTY, LABEL_CONTENT_TYPE_PROPERTY, LABEL_PROPERTY

Fields inherited from interface io.guise.framework.model.ui.PresentationModel

BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
HeadingLink()	Default constructor.
HeadingLink(int level)	Heading level constructor.
HeadingLink(InfoModel infoModel)	Info model constructor.
HeadingLink(InfoModel labelModel, int level)	Info model constructor.
HeadingLink(InfoModel infoModel, ActionModel actionModel, Enableable enableable)	Info model, action model, and enableable object constructor.
HeadingLink(InfoModel labelModel, ActionModel actionModel, Enableable enableable, int level)	Info model, action model, and enableable object constructor.
HeadingLink(ActionPrototype actionPrototype)	Prototype constructor.
HeadingLink(ActionPrototype actionPrototype, int level)	Prototype constructor.
HeadingLink(java.lang.String label)	Label convenience constructor.
HeadingLink(java.lang.String label, int level)	Label convenience constructor.
HeadingLink(java.lang.String label, int level, com.globalmentor.net.URIPath navigationPath)	Label and navigation path convenience constructor.
HeadingLink(java.lang.String label, int level, java.net.URI navigationURI)	Label and navigation URI convenience constructor.
HeadingLink(java.lang.String label, com.globalmentor.net.URIPath navigationPath)	Label and navigation path convenience constructor.
HeadingLink(java.lang.String label, java.net.URI navigationURI)	Label and navigation URI convenience constructor.

Method Summary

Modifier and Type	Method	Description
int	getLevel()
void	setLevel(int newLevel)	Sets the level of the heading.

Methods inherited from class io.guise.framework.component.AbstractActionControl

addActionListener, fireActionPerformed, fireActionPerformed, getActionListeners, getActionModel, isIconDisplayed, isLabelDisplayed, isRollover, performAction, performAction, removeActionListener, setIconDisplayed, setLabelDisplayed, setRollover

Methods inherited from class io.guise.framework.component.AbstractControl

determineStatus, getEnableable, getStatus, isEnabled, reset, setEnabled, setNotification, setStatus, updateStatus, updateValid

Methods inherited from class io.guise.framework.component.AbstractComponent

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, depict, determineValid, dispatchInputEvent, equals, exportTransfer, fireInputEvent, fireNotified, fireNotified, getAncestor, getCommandListeners, getComponentByID, getComponentByName, getComponentOrientation, getConstraints, getDepictID, getDepictor, getDescription, getDescriptionContentType, getDirtyComponents, getDirtyComponents, getEventListenerManager, getFlyoverStrategy, getGlyphURI, getInfo, getInfoContentType, getInfoModel, getInputStrategy, getKeyListeners, getLabel, getLabelContentType, getMouseListeners, getName, getNotification, getNotifications, getNotifications, getOrientation, getParent, getPreferenceProperties, getRootComponent, getTheme, hasAncestor, hasCommandListeners, hashCode, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, processEvent, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDepicted, setDescription, setDescriptionContentType, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setGlyphURI, setInfo, setInfoContentType, setInputStrategy, setLabel, setLabelContentType, setName, setOrientation, setParent, setThemeApplied, setValid, toString, update, updateTheme, validate

Methods inherited from class io.guise.framework.model.ui.AbstractPresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from class io.guise.framework.event.GuiseBoundPropertyObject

getSession

Methods inherited from class com.globalmentor.beans.BoundPropertyObject

addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.guise.framework.component.ActionControl

isRollover, setRollover

Methods inherited from interface io.guise.framework.event.ActionListenable

addActionListener, removeActionListener

Methods inherited from interface io.guise.framework.model.ActionModel

getActionListeners, performAction, performAction

Methods inherited from interface io.guise.framework.component.Component

addCommandListener, addExportStrategy, addImportStrategy, addKeyListener, addMouseListener, addNotificationListener, addPreferenceProperty, applyTheme, applyTheme, dispatchInputEvent, exportTransfer, fireInputEvent, getAncestor, getComponentOrientation, getConstraints, getDepictor, getFlyoverStrategy, getInputStrategy, getName, getNotification, getOrientation, getParent, getPreferenceProperties, getTheme, hasCommandListeners, hasKeyListeners, hasMouseListeners, importTransfer, initialize, isDragEnabled, isDropEnabled, isFlyoverEnabled, isPreferenceProperty, isThemeApplied, isValid, loadPreferences, notify, removeCommandListener, removeExportStrategy, removeImportStrategy, removeKeyListener, removeMouseListener, removeNotificationListener, removePreferenceProperty, resetTheme, savePreferences, setConstraints, setDragEnabled, setDropEnabled, setFlyoverEnabled, setFlyoverStrategy, setInputStrategy, setName, setNotification, setOrientation, setParent, setThemeApplied, updateTheme, validate

Methods inherited from interface io.guise.framework.component.Control

getStatus, reset

Methods inherited from interface io.guise.framework.platform.DepictedObject

depict, getDepictID, getSession, processEvent

Methods inherited from interface io.guise.framework.model.Enableable

isEnabled, setEnabled

Methods inherited from interface io.guise.framework.model.InfoModel

getDescription, getDescriptionContentType, getInfo, getInfoContentType, setDescription, setDescriptionContentType, setInfo, setInfoContentType

Methods inherited from interface io.guise.framework.component.LabelDisplayableComponent

isIconDisplayed, isLabelDisplayed, setIconDisplayed, setLabelDisplayed

Methods inherited from interface io.guise.framework.model.LabelModel

getGlyphURI, getLabel, getLabelContentType, setGlyphURI, setLabel, setLabelContentType

Methods inherited from interface io.guise.framework.model.ui.PresentationModel

BorderLineFarColor, BorderLineFarExtent, BorderLineFarStyle, BorderLineNearColor, BorderLineNearExtent, BorderLineNearStyle, BorderPageFarColor, BorderPageFarExtent, BorderPageFarStyle, BorderPageNearColor, BorderPageNearExtent, BorderPageNearStyle, getBackgroundColor, getBorderColor, getBorderExtent, getBorderStyle, getCornerArcSize, getCornerLineFarPageFarArcSize, getCornerLineFarPageNearArcSize, getCornerLineNearPageFarArcSize, getCornerLineNearPageNearArcSize, getCursor, getExtent, getFontFamilies, getFontSize, getFontStyle, getFontWeight, getLabelFontFamilies, getLabelFontSize, getLabelFontStyle, getLabelFontWeight, getLabelTextColor, getLineExtent, getMarginExtent, getMarginLineFarExtent, getMarginLineNearExtent, getMarginPageFarExtent, getMarginPageNearExtent, getOpacity, getPaddingExtent, getPaddingLineFarExtent, getPaddingLineNearExtent, getPaddingPageFarExtent, getPaddingPageNearExtent, getPageExtent, getSession, getStyleID, getTextColor, isDisplayed, isTooltipEnabled, isVisible, setBackgroundColor, setBorderColor, setBorderColor, setBorderExtent, setBorderExtent, setBorderLineFarColor, setBorderLineFarExtent, setBorderLineFarStyle, setBorderLineNearColor, setBorderLineNearExtent, setBorderLineNearStyle, setBorderPageFarColor, setBorderPageFarExtent, setBorderPageFarStyle, setBorderPageNearColor, setBorderPageNearExtent, setBorderPageNearStyle, setBorderStyle, setBorderStyle, setCornerArcSize, setCornerArcSize, setCornerLineFarPageFarArcSize, setCornerLineFarPageNearArcSize, setCornerLineNearPageFarArcSize, setCornerLineNearPageNearArcSize, setCursor, setDisplayed, setExtent, setFontFamilies, setFontSize, setFontStyle, setFontWeight, setLabelFontFamilies, setLabelFontSize, setLabelFontStyle, setLabelFontWeight, setLabelTextColor, setLineExtent, setMarginExtent, setMarginExtent, setMarginLineFarExtent, setMarginLineNearExtent, setMarginPageFarExtent, setMarginPageNearExtent, setOpacity, setPaddingExtent, setPaddingExtent, setPaddingLineFarExtent, setPaddingLineNearExtent, setPaddingPageFarExtent, setPaddingPageNearExtent, setPageExtent, setStyleID, setTextColor, setTooltipEnabled, setVisible

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Constructor Detail

HeadingLink

public HeadingLink()

Default constructor.

HeadingLink

public HeadingLink(java.lang.String label)

Label convenience constructor.

Parameters:

label - The label to use in the link, or null if there should be no label.

HeadingLink

public HeadingLink(InfoModel infoModel)

Info model constructor.

Parameters:

infoModel - The component info model.

Throws:

java.lang.NullPointerException - if the given info model is null.

HeadingLink

public HeadingLink(InfoModel infoModel,
                   ActionModel actionModel,
                   Enableable enableable)

Info model, action model, and enableable object constructor.

Parameters:

infoModel - The component info model.

actionModel - The component action model.

enableable - The enableable object in which to store enabled status.

Throws:

java.lang.NullPointerException - if the given info model, action model, and/or enableable object is null.

HeadingLink

public HeadingLink(java.lang.String label,
                   com.globalmentor.net.URIPath navigationPath)

Label and navigation path convenience constructor. A NavigateActionListener will be installed to navigate to the provided navigation path.

Parameters:

label - The label to use in the link, or null if there should be no label.

navigationPath - The destination path that will be used for navigation when the link is selected.

Throws:

java.lang.NullPointerException - if the given navigation path is null.

HeadingLink

public HeadingLink(java.lang.String label,
                   java.net.URI navigationURI)

Label and navigation URI convenience constructor. A NavigateActionListener will be installed to navigate to the provided navigation URI.

Parameters:

label - The label to use in the link, or null if there should be no label.

navigationURI - The destination URI that will be used for navigation when the link is selected.

Throws:

java.lang.NullPointerException - if the given navigation URI is null.

HeadingLink

public HeadingLink(ActionPrototype actionPrototype)

Prototype constructor.

Parameters:

actionPrototype - The prototype on which this component should be based.

Throws:

java.lang.NullPointerException - if the given prototype is null.

HeadingLink

public HeadingLink(int level)

Heading level constructor.

Parameters:

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

HeadingLink

public HeadingLink(java.lang.String label,
                   int level)

Label convenience constructor.

Parameters:

label - The label to use in the link, or null if there should be no label.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

HeadingLink

public HeadingLink(InfoModel labelModel,
                   int level)

Info model constructor.

Parameters:

labelModel - The component info model.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

Throws:

java.lang.NullPointerException - if the given info model is null.

HeadingLink

public HeadingLink(InfoModel labelModel,
                   ActionModel actionModel,
                   Enableable enableable,
                   int level)

Info model, action model, and enableable object constructor.

Parameters:

labelModel - The component info model.

actionModel - The component action model.

enableable - The enableable object in which to store enabled status.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

Throws:

java.lang.NullPointerException - if the given info model, action model, and/or enableable object is null.

HeadingLink

public HeadingLink(java.lang.String label,
                   int level,
                   com.globalmentor.net.URIPath navigationPath)

Label and navigation path convenience constructor. A NavigateActionListener will be installed to navigate to the provided navigation path.

Parameters:

label - The label to use in the link, or null if there should be no label.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

navigationPath - The destination path that will be used for navigation when the link is selected.

Throws:

java.lang.NullPointerException - if the given navigation path is null.

HeadingLink

public HeadingLink(java.lang.String label,
                   int level,
                   java.net.URI navigationURI)

Label and navigation URI convenience constructor. A NavigateActionListener will be installed to navigate to the provided navigation URI.

Parameters:

label - The label to use in the link, or null if there should be no label.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

navigationURI - The destination URI that will be used for navigation when the link is selected.

Throws:

java.lang.NullPointerException - if the given navigation URI is null.

HeadingLink

public HeadingLink(ActionPrototype actionPrototype,
                   int level)

Prototype constructor.

Parameters:

actionPrototype - The prototype on which this component should be based.

level - The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

Throws:

java.lang.NullPointerException - if the given prototype is null.

Method Detail

getLevel

public int getLevel()

Specified by:

getLevel in interface HeadingComponent

Returns:

The zero-based level of the heading, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

setLevel

public void setLevel(int newLevel)

Description copied from interface: HeadingComponent

Sets the level of the heading. This is a bound property of type Integer.

Specified by:

setLevel in interface HeadingComponent

Parameters:

newLevel - The new zero-based heading level, or HeadingComponent.NO_HEADING_LEVEL if no level is specified.

See Also:

HeadingComponent.LEVEL_PROPERTY