Package org.hippoecm.frontend.plugins.standards.perspective

Class Perspective

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.hippoecm.frontend.service.render.AbstractRenderService<T>
org.hippoecm.frontend.service.render.RenderService<T>
org.hippoecm.frontend.service.render.RenderPlugin<Void>
org.hippoecm.frontend.plugins.standards.perspective.Perspective
All Implemented Interfaces:
Serializable, Iterable<org.apache.wicket.Component>, EventListener, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, 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, IObserver, IPlugin, IRenderService, ITitleDecorator, IconProvider
Direct Known Subclasses:
PanelPluginPerspective
public abstract class Perspective extends RenderPlugin<Void> implements ITitleDecorator
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.hippoecm.frontend.service.render.RenderService

    RenderService.ExtensionPoint

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLUSTER_NAME
     
    static final String
    CLUSTER_PARAMETERS
     
    static final String
    FALLBACK_IMAGE_EXTENSION
     
    static final String
    IMAGE_EXTENSION
     
    static final String
    TITLE_KEY
     

    Fields inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

    BEHAVIOR, children, CSS_ID, DEFAULT_LOCALE, EXTENSIONS_ID, FEEDBACK, FEEDBACK_SCOPE, MODEL_ID, SKIN_ID, VARIANT_ID, VISIBLE, WICKET_ID

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

    PANEL

    Fields inherited from class org.apache.wicket.Component

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

    Fields inherited from interface org.hippoecm.frontend.plugin.IPlugin

    CLASSNAME

    Fields inherited from interface org.hippoecm.frontend.service.ITitleDecorator

    log

  • Constructor Summary

    Constructors
    Constructor
    Description
    Perspective(IPluginContext context, IPluginConfig config)
     
    Perspective(IPluginContext context, IPluginConfig config, String eventId)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAppPath()
     
    org.apache.wicket.request.resource.ResourceReference
    getIcon(IconSize size)
    Retrieve an icon to represent the decorated object.
    org.apache.wicket.model.IModel<String>
    getTitle()
     
    String
    getTitleCssClass()
     
    protected boolean
    isActivating()
     
    protected void
    onActivated()
    Hook called when the perspective is activated, i.e.
    protected void
    onDeactivated()
    Hook called when the perspective is deactivate, i.e.
    protected void
    publishEvent(String name)
     
    void
    render(PluginRequestTarget target)
    Called after user events and JCR events have been handled, but before the rendering has started.
    void
    renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
     
    protected void
    setTitle(String title)
     
    protected void
    setTitle(org.apache.wicket.model.IModel<String> title)
     
    protected String
    toImageName(String camelCaseString, IconSize size, String extension)
     

    Methods inherited from class org.hippoecm.frontend.service.render.RenderPlugin

    newPlugin, newPlugin, onStart, onStop, start, stop

    Methods inherited from class org.hippoecm.frontend.service.render.RenderService

    createExtensionPoint

    Methods inherited from class org.hippoecm.frontend.service.render.AbstractRenderService

    addExtensionPoint, bind, focus, getBundleName, getComponent, getDialogService, getId, getMarkupId, getModel, getModelObject, getObservable, getParentService, getPluginConfig, getPluginContext, getResourceBundleModel, getSession, getVariation, isActive, onAfterRender, onBeforeRender, onComponentTag, onComponentTagBody, onEvent, redraw, removeExtensionPoint, setDefaultModel, setModel, setModelObject, unbind, updateModel

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

    getRegionMarkup, 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, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

    Methods inherited from class org.apache.wicket.Component

    add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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 org.hippoecm.frontend.skin.IconProvider

    getIcon

    Methods inherited from interface org.apache.wicket.IQueueRegion

    dequeue, newDequeueContext

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Field Details

  • Constructor Details

  • Method Details

    • getTitleCssClass

      public String getTitleCssClass()

    • getAppPath

      public String getAppPath()

    • getTitle

      public org.apache.wicket.model.IModel<String> getTitle()
      Specified by:
      getTitle in interface ITitleDecorator

    • setTitle

      protected void setTitle(org.apache.wicket.model.IModel<String> title)

    • setTitle

      protected void setTitle(String title)

    • getIcon

      public org.apache.wicket.request.resource.ResourceReference getIcon(IconSize size)
      Description copied from interface: ITitleDecorator
      Retrieve an icon to represent the decorated object. Implementations should return null when no icon is available. When no icon is available of the specified size, a larger sized icon can be returned.

      Consumers should use a default icon when none is returned. They should handle resizing icons when these are not of the specified size.

      Specified by:
      getIcon in interface ITitleDecorator

    • toImageName

      protected String toImageName(String camelCaseString, IconSize size, String extension)

    • renderHead

      public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
      Specified by:
      renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
      Overrides:
      renderHead in class org.apache.wicket.Component

    • render

      public void render(PluginRequestTarget target)
      Description copied from class: AbstractRenderService
      Called after user events and JCR events have been handled, but before the rendering has started. Plugins can register Components with the request target to enlist in the rendering phase.

      Implementations that use extensions must call the same method on those.

      Specified by:
      render in interface IRenderService
      Overrides:
      render in class RenderPlugin<Void>

    • onActivated

      protected void onActivated()
      Hook called when the perspective is activated, i.e. transitions from inactive to active state. When overiding, make sure to call super.onActivated() in order to keep the usage statistics working.

    • onDeactivated

      protected void onDeactivated()
      Hook called when the perspective is deactivate, i.e. transitions from active to inactive state. When overriding, make sure to call super.onDeactivated().

    • isActivating

      protected boolean isActivating()
      Returns:
      true when the perspective is transitioning from deactivated -> activated

    • publishEvent

      protected void publishEvent(String name)