com.neurosys.reporting.wicket.components

Class GenericPoppableReportResult<T extends Serializable>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

com.neurosys.reporting.wicket.components.ReportResult<T,RM>

com.neurosys.reporting.wicket.components.PoppableReportResult<T,ReporterMeta>

com.neurosys.reporting.wicket.components.GenericPoppableReportResult<T>

Type Parameters:

T - type of record

All Implemented Interfaces:

ChangeListener<Object[]>, Serializable, EventListener, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

public class GenericPoppableReportResult<T extends Serializable>
extends PoppableReportResult<T,ReporterMeta>

Implementation of PoppableReportResult for generic purpose. This class assumes only one type of record is being used or type T.

If the entity of type T has field thjat matches clickableFieldNames then, for those fields a SelectableRecord Fragment is created that contains
AbstractLink link = makePoppable("detailsLink", (Serializable)record, fieldName)
; in the Cell to PoppableReportResult.makePoppable(String, Object, String, Object...) else getComponentForCell(String, Object, Object, int, String, ReporterMeta) is called.

Author:

Ishan Mitra, Arjun Dhar

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.Component.VisibilityChange

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIB_TRANSFORM_RECORD A Transformer that converts the record into the desired entity for the target panel to display.

Fields inherited from class com.neurosys.reporting.wicket.components.ReportResult

authorizationModule, params, secirityLog

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
GenericPoppableReportResult(String id)
GenericPoppableReportResult(String id, org.apache.wicket.model.IModel<ReporterMeta> model, org.apache.wicket.MarkupContainer targetPanel, Object[] params)
GenericPoppableReportResult(String id, org.apache.wicket.model.IModel<ReporterMeta> model, Object[] params)

Method Summary

Modifier and Type	Method and Description
protected org.apache.wicket.Component	getComponentForCell(String componentId, Object value, Object record, int colIndex, String fieldName, ReporterMeta reporterMeta) By default converts every cell data into a Label
protected void	onRecordClick(org.apache.wicket.ajax.AjaxRequestTarget target, String id, Object record, String fieldName, Object... context) The target panel is set and added.
void	setClickableFieldNames(Collection<String> clickableFieldNames) Collection of field names for the record that will be click-able.
void	setTargetPanel(org.apache.wicket.MarkupContainer targetPanel) Component that should be displayed when a click-able field is clicked.

Methods inherited from class com.neurosys.reporting.wicket.components.PoppableReportResult

defineReportDataProvider, makePoppable

Methods inherited from class com.neurosys.reporting.wicket.components.ReportResult

defineColumns, filter, getDataPanel, getParams, getStatelessHint, onChange, onInitialize, populateBulkButtonItem, secure, setParams

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

getMarkupType, getWebPage, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIB_TRANSFORM_RECORD

public static final String ATTRIB_TRANSFORM_RECORD

A Transformer that converts the record into the desired entity for the target panel to display. The record is in the form left by Reporter.getRecordTransformer()

See Also:

Constant Field Values

Constructor Detail

GenericPoppableReportResult

public GenericPoppableReportResult(String id)

GenericPoppableReportResult

public GenericPoppableReportResult(String id,
                                   org.apache.wicket.model.IModel<ReporterMeta> model,
                                   Object[] params)

GenericPoppableReportResult

public GenericPoppableReportResult(String id,
                                   org.apache.wicket.model.IModel<ReporterMeta> model,
                                   org.apache.wicket.MarkupContainer targetPanel,
                                   Object[] params)

Method Detail

onRecordClick

protected void onRecordClick(org.apache.wicket.ajax.AjaxRequestTarget target,
                             String id,
                             Object record,
                             String fieldName,
                             Object... context)

The target panel is set and added. If the component is Initializable, then it will be initialized as well.

Specified by:

onRecordClick in class PoppableReportResult<T extends Serializable,ReporterMeta>

Parameters:

target - as AjaxRequestTarget

id - as Component Id

record - as Object

fieldName - as String; same as supplied to PoppableReportResult.makePoppable(String, Object, String, Object...)

context - Object... additional params

getComponentForCell

protected org.apache.wicket.Component getComponentForCell(String componentId,
                                                          Object value,
                                                          Object record,
                                                          int colIndex,
                                                          String fieldName,
                                                          ReporterMeta reporterMeta)

Description copied from class: ReportResult

By default converts every cell data into a Label

Overrides:

getComponentForCell in class ReportResult<T extends Serializable,ReporterMeta>

Parameters:

componentId - as String, passed Id for component from the Container like a Data grid

value - as Object of the cell

record - as Object, defining the row as a List, Array or any Entity

colIndex - as int

fieldName - as String (Name of the field if its an entity or ColIndex is not)

reporterMeta - as

Returns:

Component

setTargetPanel

public void setTargetPanel(org.apache.wicket.MarkupContainer targetPanel)

Component that should be displayed when a click-able field is clicked. If the component is Initializable, then it will be initialized when a field is clicked.

Parameters:

targetPanel -

setClickableFieldNames

public void setClickableFieldNames(Collection<String> clickableFieldNames)

Collection of field names for the record that will be click-able.

Parameters:

clickableFieldNames -