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

Class DeleteRecordAction<R extends PersistentRecord>

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
com.inductiveautomation.ignition.gateway.web.components.actions.AbstractLinkAction
com.inductiveautomation.ignition.gateway.web.components.actions.AbstractRecordInstanceAction<R>
com.inductiveautomation.ignition.gateway.web.components.actions.DeleteRecordAction<R>
All Implemented Interfaces:
IConfirmedTask, IConfigPage.IConfigLinkHandler, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
Direct Known Subclasses:
RecordActionTable.RecordActionTableDelete
public class DeleteRecordAction<R extends PersistentRecord> extends AbstractRecordInstanceAction<R> implements IConfirmedTask
See Also:

  • Field Summary

    Fields inherited from class com.inductiveautomation.ignition.gateway.web.components.actions.AbstractLinkAction

    configPage, parentPanel

    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

  • Constructor Summary

    Constructors
    Constructor
    Description
    DeleteRecordAction(String id, IConfigPage configPage, ConfigPanel parentPanel, R record)
     

  • Method Summary

    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.
    Class<? extends org.apache.wicket.Page>
    execute(org.apache.wicket.Component owner)
    Executes this task when the user confirms it.
    protected 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
    String
    getRecordTypeNoun(org.apache.wicket.Component owner)
     
    String
    getRecordTypeNoun(SRecordMeta<?> meta, org.apache.wicket.Component owner)
     
    void
    onDelete(R record)
    Called after the record is successfully deleted

    Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.actions.AbstractRecordInstanceAction

    getModelObjectAsRecord, getPanel

    Methods inherited from class com.inductiveautomation.ignition.gateway.web.components.actions.AbstractLinkAction

    getConfigPage, getParentPanel, initComponents, isEscapeMarkup

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

    newMarkupSourcingStrategy

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

    getWebApplication, 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, clearOriginalDestination, 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, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, 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 Details

  • Method Details

    • getCssClass

      protected 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

    • getLabel

      public org.apache.wicket.model.IModel getLabel()
      Description copied from class: AbstractLinkAction
      Return the link text
      Specified by:
      getLabel in class AbstractLinkAction

    • doDelete

      public void doDelete(R record, org.apache.wicket.Component owner) throws Exception
      Responsible for actually deleting the record. Must call canDelete() before the delete happens (and not any exceptions), and call onDelete() afterwards.
      Throws:
      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 String getRecordTypeNoun(org.apache.wicket.Component owner)

    • getRecordTypeNoun

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

    • canDelete

      public void canDelete(R record) throws ConfirmedTaskVetoException
      Provides subclasses a chance to determine whether or not an object can be deleted. Throw an exception if it cannot be deleted
      Throws:
      ConfirmedTaskVetoException

    • onDelete

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

    • createPanel

      public ConfigPanel createPanel(R record)
      Specified by:
      createPanel in class AbstractRecordInstanceAction<R extends PersistentRecord>

    • execute

      public Class<? extends org.apache.wicket.Page> execute(org.apache.wicket.Component owner) throws 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:
      Exception