Package com.nomagic.magicdraw.hyperlinks.ui

Class HyperlinkEditorPanel

  • All Implemented Interfaces:
    HyperlinkEditor, java.awt.event.FocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible
    @OpenApi
public abstract class HyperlinkEditorPanel
extends ExtendedPanel
implements HyperlinkEditor
    The panel used for hyperlink specification.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JPanel

        javax.swing.JPanel.AccessibleJPanel

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private javax.swing.JButton mClearButton  
      private com.nomagic.awt.ExtendedList<Hyperlink> mFavorites
      Favorites links.
      private HyperlinkHandler mHandler  
      private com.nomagic.ui.FocusTextField mLinkAddress
      Link address.
      private java.lang.String mTitle  

      • 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​(java.lang.String title, java.lang.String linkLabelName, boolean editable, HyperlinkHandler handler, java.lang.String defaultProtocol)
      Constructor.

    • Method Summary

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

      • 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

    • Field Detail

      • mLinkAddress

        private final com.nomagic.ui.FocusTextField mLinkAddress
        Link address.

      • mFavorites

        private final com.nomagic.awt.ExtendedList<Hyperlink> mFavorites
        Favorites links.

      • mClearButton

        private final javax.swing.JButton mClearButton

      • mTitle

        private final java.lang.String mTitle

    • Constructor Detail

      • HyperlinkEditorPanel

        @OpenApi
public HyperlinkEditorPanel​(java.lang.String title,
                            java.lang.String linkLabelName,
                            boolean editable,
                            HyperlinkHandler handler,
                            java.lang.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 Detail

      • createLinkAddressTextField

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

      • createLinkLabel

        protected javax.swing.JComponent createLinkLabel​(java.lang.String linkLabelName)

      • clearFavorites

        private void clearFavorites()

      • browse

        @OpenApi
protected abstract void browse()
        Browse the hyperlink value.

      • getTitle

        public final java.lang.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​(java.lang.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 java.lang.String formUrl​(java.lang.String linkAddress)
        Form URL from given link address.
        Parameters:
        linkAddress - link address.
        Returns:
        URL string.

      • getDefaultFocusable

        public java.awt.Component getDefaultFocusable()
        Description copied from class: ExtendedPanel
        Request Focus for some component. Here it is empty.

      • setHyperlinkUrlText

        @OpenApi
protected final void setHyperlinkUrlText​(@CheckForNull
                                         java.lang.String url)
        Set hyperlink url text.
        Parameters:
        url - uer text.

      • getHyperlinkUrlText

        @OpenApi
protected final java.lang.String getHyperlinkUrlText()
        Get hyperlink url text.
        Returns:
        url text.