Package de.hybris.platform.platformbackoffice.actions

Class ScriptingAction

  • All Implemented Interfaces:
    com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>, com.hybris.cockpitng.actions.CockpitActionRenderer<java.lang.Object,​java.lang.Object>
    public class ScriptingAction
extends com.hybris.cockpitng.actions.impl.DefaultActionRenderer<java.lang.Object,​java.lang.Object>
implements com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>
    An action that executes scipts from scripting engine from platform. The script is identified by scriptUri that can be one of:

    Classpath script resource: 

                    classpath://path/to/script.groovy
                classpath://path/to/file.bsh
                classpath://path/to/file.js
    File script resurce: 
                    file:///absolute/path/to/script.groovy
                file://c:/absolute/path/to/script.js
    Media script resource: 
                    model://codeOfScriptItem
                model://codeOfScriptItem/revisionNumber
    Remote script resource: 
                    http://server.com/path/to/script.groovy
                https://server.com/path/to/script.groovy
                ftp://server.com/path/to/script.js

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.hybris.cockpitng.actions.impl.DefaultActionRenderer

        com.hybris.cockpitng.actions.impl.DefaultActionRenderer.DefaultActionRendererEventListener<T extends org.zkoss.zk.ui.event.Event>

    • Constructor Summary

      Constructors 
      Constructor Description
      ScriptingAction()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean canPerform​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)  
      java.lang.String getConfirmationMessage​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)  
      protected java.lang.String getIconUri​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> context, boolean canPerform)  
      protected java.lang.String getLocalizedName​(com.hybris.cockpitng.actions.ActionContext<?> context)  
      boolean needsConfirmation​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)  
      com.hybris.cockpitng.actions.ActionResult<java.lang.Object> perform​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)  
      void render​(org.zkoss.zk.ui.Component component, com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object> cockpitAction, com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext, boolean updateMode, com.hybris.cockpitng.actions.ActionListener<java.lang.Object> actionListener)  
      protected com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object> resolveActionScript​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)  

      • Methods inherited from class com.hybris.cockpitng.actions.impl.DefaultActionRenderer

        addEventListener, addKeyboardSupport, adjustUri, checkDataCompatibleWithDefinedInput, createEventListener, createYTestId, extractIconDisabledUri, extractIconHoverUri, extractIconUri, extractKeyEvent, findActionComponent, findGroupComponent, findParentComponent, getActionBodySclass, getIconHoverUri, getKeyboardSupportService, getOrCreateContainer, getOrCreateIcon, getOrCreateIcon, getOrCreateLabel, getOrCreateLabel, getTooltipText, getToolTipWithCtrlKeysText, loadFromParentModel, perform, performWithConfirmationCheck, registerHoverEventsOnContainer, removeEventListeners, removeEventListeners, removeIcon, removeLabel, setTooltipText, storeInParentModel, triggerFromKeyEvent

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • PARAMETER_SCRIPT_URI

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

      • PARAMETER_LABEL

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

      • ACTION_ICON_URI

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

      • DISABLED_ACTION_ICON_URI

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

      • ACTION_ICON_FALLBACK

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

      • DISABLED_ACTION_ICON_FALLBACK

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

      • BROKEN_ACTION_ICON_FALLBACK

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

    • Constructor Detail

      • ScriptingAction

        public ScriptingAction()

    • Method Detail

      • perform

        public com.hybris.cockpitng.actions.ActionResult<java.lang.Object> perform​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)
        Specified by:
        perform in interface com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>

      • canPerform

        public boolean canPerform​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)
        Specified by:
        canPerform in interface com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>

      • needsConfirmation

        public boolean needsConfirmation​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)
        Specified by:
        needsConfirmation in interface com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>

      • getConfirmationMessage

        public java.lang.String getConfirmationMessage​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)
        Specified by:
        getConfirmationMessage in interface com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object>

      • render

        public void render​(org.zkoss.zk.ui.Component component,
                   com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object> cockpitAction,
                   com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext,
                   boolean updateMode,
                   com.hybris.cockpitng.actions.ActionListener<java.lang.Object> actionListener)
        Specified by:
        render in interface com.hybris.cockpitng.actions.CockpitActionRenderer<java.lang.Object,​java.lang.Object>
        Overrides:
        render in class com.hybris.cockpitng.actions.impl.DefaultActionRenderer<java.lang.Object,​java.lang.Object>

      • getIconUri

        protected java.lang.String getIconUri​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> context,
                                      boolean canPerform)
        Overrides:
        getIconUri in class com.hybris.cockpitng.actions.impl.DefaultActionRenderer<java.lang.Object,​java.lang.Object>

      • getLocalizedName

        protected java.lang.String getLocalizedName​(com.hybris.cockpitng.actions.ActionContext<?> context)
        Overrides:
        getLocalizedName in class com.hybris.cockpitng.actions.impl.DefaultActionRenderer<java.lang.Object,​java.lang.Object>

      • resolveActionScript

        protected com.hybris.cockpitng.actions.CockpitAction<java.lang.Object,​java.lang.Object> resolveActionScript​(com.hybris.cockpitng.actions.ActionContext<java.lang.Object> actionContext)