Package com.im.ijc.core.api.actions

Class AbstractIJCAction

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.io.Externalizable, java.io.Serializable, java.util.EventListener, javax.swing.Action, org.openide.util.actions.Presenter, org.openide.util.actions.Presenter.Menu, org.openide.util.actions.Presenter.Popup, org.openide.util.actions.Presenter.Toolbar, org.openide.util.ContextAwareAction, org.openide.util.HelpCtx.Provider
    Direct Known Subclasses:
    AbstractIJCWidgetCookieAction, AbstractVertexStateCookieAction, DeleteRowsAction, InsertRowAction, StopQueryAction
    public abstract class AbstractIJCAction
extends AbstractToolbarCookieAction
    The main class in the IJC actions hierarchy. Usually an action in IJC wants to be either DFResultSet.VertexState or widget sensitive or both. That is it might listen on changes in which it is interested and implementations might conveniently set their enablement state and adjust their behaviour accordingly.

    AbstractIJCAction can handle all cases. Implementations might tell their preference via AbstractIJCAction(boolean, boolean) constructor.

    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.openide.util.actions.Presenter

        org.openide.util.actions.Presenter.Menu, org.openide.util.actions.Presenter.Popup, org.openide.util.actions.Presenter.Toolbar

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String ALL_ICONS_PREFIX  

      • Fields inherited from class org.openide.util.actions.CookieAction

        MODE_ALL, MODE_ANY, MODE_EXACTLY_ONE, MODE_ONE, MODE_SOME

      • Fields inherited from class org.openide.util.actions.SystemAction

        PROP_ENABLED, PROP_ICON

      • Fields inherited from interface javax.swing.Action

        ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addListenerTo​(IJCWidget widget, java.beans.PropertyChangeListener selectionListener)  
      protected boolean asynchronous()  
      protected java.lang.Class<?>[] cookieClasses()  
      boolean enable​(org.openide.nodes.Node[] activatedNodes)  
      protected boolean enableAccordingTo​(com.im.df.api.dml.DFResultSet.VertexState vs, IJCWidget widget)  
      protected boolean enableAccordingToBasic​(com.im.df.api.dml.DFResultSet.VertexState vs, IJCWidget widget)  
      protected boolean enableOnlyInBrowseMode()
      Says whether an action should be enabled only in browse mode.
      protected boolean enableWhenNoResultSet()  
      protected boolean enableWhenNoRows()  
      protected boolean enableWhenNotBound()  
      protected com.im.df.api.dml.DFResultSet.VertexState findVS​(org.openide.nodes.Node[] activatedNodes)  
      protected static IJCWidget findWidget​(org.openide.nodes.Node[] activatedNodes)  
      org.openide.util.HelpCtx getHelpCtx()  
      protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIds​(com.im.df.api.dml.DFResultSet.VertexState vs, IJCWidget widget)  
      protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIdsSafely​(java.lang.String lockingMsg, com.im.df.api.dml.DFResultSet.VertexState vs)  
      protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIdsSafely​(java.lang.String lockingMsg, com.im.df.api.dml.DFResultSet.VertexState vs, IJCWidget widget)  
      protected static com.im.df.api.support.SelectionDescription getSelection​(com.im.df.api.dml.DFResultSet.VertexState vs, IJCWidget widget)  
      protected boolean handleHookEvent​(AbstractViewTopComponent form, java.lang.String eventName, java.util.Map<java.lang.String,​java.lang.Object> eventParams)  
      protected boolean isEventInteresting​(java.beans.PropertyChangeEvent evt)  
      protected int mode()  
      protected void removeListenerFrom​(IJCWidget widget, java.beans.PropertyChangeListener selectionListener)  
      protected void updateEnabledState()  

      • Methods inherited from class org.openide.util.actions.CookieAction

        createContextAwareInstance

      • Methods inherited from class org.openide.util.actions.NodeAction

        actionPerformed, addNotify, getActivatedNodes, initialize, isEnabled, performAction, performAction, removeNotify, setEnabled, surviveFocusChange

      • Methods inherited from class org.openide.util.actions.CallableSystemAction

        getMenuPresenter, getPopupPresenter

      • Methods inherited from class org.openide.util.actions.SystemAction

        clearSharedData, createPopupMenu, createToolbarPresenter, get, getIcon, getIcon, getName, getValue, iconResource, linkActions, putValue, setIcon

      • Methods inherited from class org.openide.util.SharedClassObject

        addPropertyChangeListener, equals, finalize, findObject, findObject, firePropertyChange, getLock, getProperty, hashCode, putProperty, putProperty, readExternal, removePropertyChangeListener, reset, writeExternal, writeReplace

      • Methods inherited from class java.lang.Object

        clone, getClass, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface javax.swing.Action

        accept, addPropertyChangeListener, getValue, putValue, removePropertyChangeListener

    • Field Detail

      • ALL_ICONS_PREFIX

        protected static final java.lang.String ALL_ICONS_PREFIX
        See Also:
        Constant Field Values

    • Constructor Detail

      • AbstractIJCAction

        public AbstractIJCAction​(boolean listenOnWidget,
                         boolean listenOnVertexState)
        Constructor by which subclass might convey in what changes it is interested.
        Parameters:
        listenOnWidget - whether action should listen on widget changed
        listenOnVertexState - whether action should listen on DFResultSet.VertexState changes

    • Method Detail

      • updateEnabledState

        protected final void updateEnabledState()

      • isEventInteresting

        protected boolean isEventInteresting​(java.beans.PropertyChangeEvent evt)

      • addListenerTo

        protected void addListenerTo​(IJCWidget widget,
                             java.beans.PropertyChangeListener selectionListener)

      • removeListenerFrom

        protected void removeListenerFrom​(IJCWidget widget,
                                  java.beans.PropertyChangeListener selectionListener)

      • mode

        protected int mode()
        Specified by:
        mode in class org.openide.util.actions.CookieAction

      • cookieClasses

        protected java.lang.Class<?>[] cookieClasses()
        Specified by:
        cookieClasses in class org.openide.util.actions.CookieAction

      • getHelpCtx

        public org.openide.util.HelpCtx getHelpCtx()
        Specified by:
        getHelpCtx in interface org.openide.util.HelpCtx.Provider
        Specified by:
        getHelpCtx in class org.openide.util.actions.SystemAction

      • enable

        public boolean enable​(org.openide.nodes.Node[] activatedNodes)
        Overrides:
        enable in class org.openide.util.actions.CookieAction

      • enableAccordingTo

        protected boolean enableAccordingTo​(com.im.df.api.dml.DFResultSet.VertexState vs,
                                    IJCWidget widget)

      • enableAccordingToBasic

        protected final boolean enableAccordingToBasic​(com.im.df.api.dml.DFResultSet.VertexState vs,
                                               IJCWidget widget)

      • asynchronous

        protected boolean asynchronous()
        Overrides:
        asynchronous in class org.openide.util.actions.CallableSystemAction

      • enableWhenNoRows

        protected boolean enableWhenNoRows()

      • enableWhenNotBound

        protected boolean enableWhenNotBound()
        Returns:
        whether action should be enabled when current activated widget is unbound, by default false

      • enableWhenNoResultSet

        protected boolean enableWhenNoResultSet()

      • enableOnlyInBrowseMode

        protected boolean enableOnlyInBrowseMode()
        Says whether an action should be enabled only in browse mode.
        Returns:
        see description

      • getSelectedIdsSafely

        protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIdsSafely​(java.lang.String lockingMsg,
                                                                                        com.im.df.api.dml.DFResultSet.VertexState vs)

      • findVS

        protected com.im.df.api.dml.DFResultSet.VertexState findVS​(org.openide.nodes.Node[] activatedNodes)

      • findWidget

        protected static IJCWidget findWidget​(org.openide.nodes.Node[] activatedNodes)

      • getSelection

        protected static com.im.df.api.support.SelectionDescription getSelection​(com.im.df.api.dml.DFResultSet.VertexState vs,
                                                                         IJCWidget widget)

      • getSelectedIds

        protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIds​(com.im.df.api.dml.DFResultSet.VertexState vs,
                                                                                  IJCWidget widget)

      • getSelectedIdsSafely

        protected static java.util.List<? extends java.lang.Comparable<?>> getSelectedIdsSafely​(java.lang.String lockingMsg,
                                                                                        com.im.df.api.dml.DFResultSet.VertexState vs,
                                                                                        IJCWidget widget)

      • handleHookEvent

        protected boolean handleHookEvent​(AbstractViewTopComponent form,
                                  java.lang.String eventName,
                                  java.util.Map<java.lang.String,​java.lang.Object> eventParams)