Package com.inductiveautomation.ignition.gateway.web.components.actions

Class DeleteRecordAction<R extends PersistentRecord>

    • Field Summary

      • Fields inherited from class org.apache.wicket.markup.html.panel.Panel

        PANEL

      • Fields inherited from class org.apache.wicket.Component

        ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void canDelete​(R record)
      Provides subclasses a chance to determine whether or not an object can be deleted.
      ConfigPanel createPanel​(R record)  
      void doDelete​(R record, org.apache.wicket.Component owner)
      Responsible for actually deleting the record.
      protected void doDeleteRelatedRecords​(PersistenceSession session, R record)
      Provides a chance for subclasses to delete any related records before this record is deleted.
      java.lang.Class<? extends org.apache.wicket.Page> execute​(org.apache.wicket.Component owner)
      Executes this task when the user confirms it.
      protected java.lang.String getCssClass()
      Returns the CSS class that will govern the style of this action component
      org.apache.wicket.model.IModel getLabel()
      Return the link text
      java.lang.String getRecordTypeNoun​(org.apache.wicket.Component owner)  
      java.lang.String getRecordTypeNoun​(SRecordMeta<?> meta, org.apache.wicket.Component owner)  
      void onDelete​(R record)
      Called after the record is successfully deleted

      • Methods inherited from class org.apache.wicket.markup.html.panel.Panel

        newMarkupSourcingStrategy

      • Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

        getWebPage, getWebRequest, getWebResponse, getWebSession

      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • DeleteRecordAction

        public DeleteRecordAction​(java.lang.String id,
                          IConfigPage configPage,
                          ConfigPanel parentPanel,
                          R record)

    • Method Detail

      • getCssClass

        protected java.lang.String getCssClass()
        Description copied from class: AbstractLinkAction
        Returns the CSS class that will govern the style of this action component
        Specified by:
        getCssClass in class AbstractLinkAction

      • doDelete

        public void doDelete​(R record,
                     org.apache.wicket.Component owner)
              throws java.lang.Exception
        Responsible for actually deleting the record. Must call canDelete() before the delete happens (and not any exceptions), and call onDelete() afterwards.
        Throws:
        java.lang.Exception

      • doDeleteRelatedRecords

        protected void doDeleteRelatedRecords​(PersistenceSession session,
                                      R record)
        Provides a chance for subclasses to delete any related records before this record is deleted. Will be called with an active SimpleORM session.

      • getRecordTypeNoun

        public java.lang.String getRecordTypeNoun​(org.apache.wicket.Component owner)

      • getRecordTypeNoun

        public java.lang.String getRecordTypeNoun​(SRecordMeta<?> meta,
                                          org.apache.wicket.Component owner)

      • onDelete

        public void onDelete​(R record)
        Called after the record is successfully deleted

      • execute

        public java.lang.Class<? extends org.apache.wicket.Page> execute​(org.apache.wicket.Component owner)
                                                          throws java.lang.Exception
        Description copied from interface: IConfirmedTask
        Executes this task when the user confirms it.
        Specified by:
        execute in interface IConfirmedTask
        Parameters:
        owner - The confirmation page itself.
        Returns:
        Optionally return a class to use as a page redirect. If null, the owner panel of the task will be returned to.
        Throws:
        java.lang.Exception