Package com.nomagic.magicdraw.hyperlinks.ui

Class HyperlinkEditorPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.nomagic.ui.ExtendedPanel

com.nomagic.magicdraw.hyperlinks.ui.HyperlinkEditorPanel

All Implemented Interfaces:

HyperlinkEditor, FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

@OpenApi
public abstract class HyperlinkEditorPanel
extends ExtendedPanel
implements HyperlinkEditor

The panel used for hyperlink specification.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.nomagic.ui.ExtendedPanel

DEFAULT_FOCUSABLE

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
HyperlinkEditorPanel(String title, String linkLabelName, boolean editable, HyperlinkHandler handler, String defaultProtocol)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	browse()	Browse the hyperlink value.
protected com.nomagic.ui.FocusTextField	createLinkAddressTextField(boolean editable, String defaultProtocol)
protected JComponent	createLinkLabel(String linkLabelName)
protected String	formUrl(String linkAddress)	Form URL from given link address.
Component	getComponent()	Get editor component.
Component	getDefaultFocusable()	Request Focus for some component.
Hyperlink	getHyperlink(String text)	Get edited hyperlink.
protected final String	getHyperlinkUrlText()	Get hyperlink url text.
final String	getTitle()	Get editor title.
final void	setFavorites(List<Hyperlink> favorites)	Set favorite hyperlinks.
void	setHyperlink(Hyperlink link)	Sets the specified hyperlink.
protected final void	setHyperlinkUrlText(String url)	Set hyperlink url text.
void	setOptions(HyperlinkEditorOptions options)	Set options which can be used in editor editor;

Methods inherited from class com.nomagic.ui.ExtendedPanel

addActionListenerFor, addEnterOKListener, addFocusListenerFor, addKeyListenerFor, cancel, clear, enableComponent, focusGained, focusLost, getEditingState, getErrorString, getParentWindow, initialize, isDataValid, ok, removeFocusListenerFor, removeKeyListenerFor, setEditingState, setEnabled, setEnabledAll, updateByStateRecursively, updatePanelByEditingState, updatePanelByEditingState

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, setFont, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Methods inherited from interface com.nomagic.magicdraw.hyperlinks.ui.HyperlinkEditor

isProjectScope

Constructor Details

HyperlinkEditorPanel

@OpenApi
public HyperlinkEditorPanel(String title,
 String linkLabelName,
 boolean editable,
 HyperlinkHandler handler,
 String defaultProtocol)

Constructor.

Parameters:

title - title.

linkLabelName - the name of the link address label.

editable - if link address is editable.

handler - hyperlink handler.

defaultProtocol - the default protocol of the hyperlinks of this panel.

Method Details

createLinkAddressTextField

protected com.nomagic.ui.FocusTextField createLinkAddressTextField(boolean editable,
 String defaultProtocol)

createLinkLabel

protected JComponent createLinkLabel(String linkLabelName)

getComponent

public Component getComponent()

Description copied from interface: HyperlinkEditor

Get editor component.

Specified by:

getComponent in interface HyperlinkEditor

Returns:

component.

setFavorites

public final void setFavorites(List<Hyperlink> favorites)

Description copied from interface: HyperlinkEditor

Set favorite hyperlinks. Editor can show favorite hyperlinks.

Deprecated Use HyperlinkEditor.setOptions(com.nomagic.magicdraw.hyperlinks.ui.HyperlinkEditorOptions)

Specified by:

setFavorites in interface HyperlinkEditor

Parameters:

favorites - favorite hyperlinks.

browse

@OpenApi
protected abstract void browse()

Browse the hyperlink value.

getTitle

public final String getTitle()

Description copied from interface: HyperlinkEditor

Get editor title.

Specified by:

getTitle in interface HyperlinkEditor

Returns:

title string.

setHyperlink

public void setHyperlink(Hyperlink link)

Sets the specified hyperlink.

Specified by:

setHyperlink in interface HyperlinkEditor

Parameters:

link - the specified hyperlink.

getHyperlink

@CheckForNull
public Hyperlink getHyperlink(String text)

Description copied from interface: HyperlinkEditor

Get edited hyperlink.

Specified by:

getHyperlink in interface HyperlinkEditor

Parameters:

text - hyperlink text.

Returns:

hyperlink.

formUrl

@CheckForNull
protected String formUrl(String linkAddress)

Form URL from given link address.

Parameters:

linkAddress - link address.

Returns:

URL string.

getDefaultFocusable

public Component getDefaultFocusable()

Description copied from class: ExtendedPanel

Request Focus for some component. Here it is empty.

Overrides:

getDefaultFocusable in class ExtendedPanel

setHyperlinkUrlText

@OpenApi
protected final void setHyperlinkUrlText(@CheckForNull
 String url)

Set hyperlink url text.

Parameters:

url - uer text.

getHyperlinkUrlText

@OpenApi
protected final String getHyperlinkUrlText()

Get hyperlink url text.

Returns:

url text.

setOptions

public void setOptions(@CheckForNull
 HyperlinkEditorOptions options)

Description copied from interface: HyperlinkEditor

Set options which can be used in editor editor;

Specified by:

setOptions in interface HyperlinkEditor

Parameters:

options - hyperlink editor options