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.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, IObserver, IPlugin, IRenderService, ITitleDecorator, IconProvider

Direct Known Subclasses:

PanelPluginPerspective

public abstract class Perspective
extends RenderPlugin<Void>
implements ITitleDecorator

See Also:

Serialized Form

Nested Class Summary

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

RenderService.ExtensionPoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLUSTER_NAME
static String	CLUSTER_PARAMETERS
static String	FALLBACK_IMAGE_EXTENSION
static String	IMAGE_EXTENSION
static String	TITLE Deprecated.
static String	TITLE_KEY

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

BEHAVIOR, children, CSS_ID, DEFAULT_LOCALE, EXTENSIONS_ID, FEEDBACK, 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_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

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

log

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

CLASSNAME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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 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 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

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, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, 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, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, 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, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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 org.hippoecm.frontend.skin.IconProvider

getIcon

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

TITLE

@Deprecated
public static final String TITLE

Deprecated.

See Also:

Constant Field Values

TITLE_KEY

public static final String TITLE_KEY

See Also:

Constant Field Values

CLUSTER_NAME

public static final String CLUSTER_NAME

See Also:

Constant Field Values

CLUSTER_PARAMETERS

public static final String CLUSTER_PARAMETERS

See Also:

Constant Field Values

IMAGE_EXTENSION

public static final String IMAGE_EXTENSION

See Also:

Constant Field Values

FALLBACK_IMAGE_EXTENSION

public static final String FALLBACK_IMAGE_EXTENSION

See Also:

Constant Field Values

Constructor Detail

Perspective

public Perspective(IPluginContext context,
                   IPluginConfig config)

Perspective

public Perspective(IPluginContext context,
                   IPluginConfig config,
                   String eventId)

Method Detail

getTitleCssClass

public String getTitleCssClass()

getTitle

public org.apache.wicket.model.IModel<String> getTitle()

Specified by:

getTitle in interface ITitleDecorator

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)

setTitle

protected void setTitle(String title)

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().

publishEvent

protected void publishEvent(String name)