public abstract class OwObjectLinksView extends OwLayout
Displays OwObjectLink
s using OwSplitObjectListView
.
For each relation specified by the corresponding OwObjectLinksDocument
a
separate object list is displayed as a split (see OwSplitObjectListView
) in the LINKS_REGION
.
A filter is displayed using the LINKS_FILTER_REGION
handling in sub classes.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
OwLayout.OwDispatchRegion, OwLayout.OwLayoutViewRefrence
Modifier and Type | Field and Description |
---|---|
static int |
LINKS_FILTER_REGION |
static int |
LINKS_REGION |
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Constructor and Description |
---|
OwObjectLinksView(OwObjectLinksDocument document) |
Modifier and Type | Method and Description |
---|---|
protected Collection<OwFieldColumnInfo> |
createColumnInfo(Collection<String> propertyList_p) |
protected Collection<OwFieldColumnInfo> |
createRelationColumnInfo(OwObjectLinkRelation relation)
(overridable)
Create relation dependent columns to display.
|
protected OwSplitObjectListDocument |
createSplitObjectListDocument(String[] splitNames,
Collection<OwFieldColumnInfo>[] propertyColumnInfos,
List<OwDocumentFunction> documentFunctions)
(overridable)
Factory to create OwSplitObjectListDocument for internal OwSplitObjectListView .
|
protected OwSplitObjectListView |
createSplitView() |
OwObjectLinksDocument |
getDocument()
gets the reference to the document
|
protected List<OwDocumentFunction> |
getDocumentFunctions() |
String |
getFilterDisplayName() |
protected void |
init()
init the target after the context is set.
|
boolean |
isEmpty() |
protected void |
onRender(Writer w_p)
called when the view should create its HTML content to be displayed
|
void |
onUpdate(OwEventTarget caller_p,
int iCode_p,
Object param_p)
called by the framework to update the view when OwDocument.Update was called
NOTE: We can not use the onRender method to update,
because we do not know the call order of onRender.
|
protected void |
refresh(OwObjectCollection[] splitLinks)
Refreshes the contents of this view for the give object link collection array.
|
void |
renderRegion(Writer w_p,
int iRegion_p)
render the views of the region
|
addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion
activate, detach, getBreadcrumbPart, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, render, renderHTMLFormular, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
public static final int LINKS_REGION
public static final int LINKS_FILTER_REGION
public OwObjectLinksView(OwObjectLinksDocument document)
public OwObjectLinksDocument getDocument()
OwView
getDocument
in class OwView
protected Collection<OwFieldColumnInfo> createColumnInfo(Collection<String> propertyList_p) throws Exception
Exception
protected void init() throws Exception
OwView
public boolean isEmpty()
protected void refresh(OwObjectCollection[] splitLinks) throws Exception
splitLinks
- Exception
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
OwLayout
renderRegion
in interface OwBaseView
renderRegion
in class OwLayout
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to renderException
public void onUpdate(OwEventTarget caller_p, int iCode_p, Object param_p) throws Exception
OwUpdateTarget
onUpdate
in interface OwUpdateTarget
onUpdate
in class OwView
caller_p
- OwEventTarget target that called updateiCode_p
- int optional reason codeparam_p
- Object optional parameter representing the refresh, depends on the value of iCode_p, can be nullException
protected void onRender(Writer w_p) throws Exception
OwView
protected List<OwDocumentFunction> getDocumentFunctions() throws OwException
OwException
protected OwSplitObjectListView createSplitView() throws Exception
OwSplitObjectListView
with the document defined splits and corresponding property column header information.Exception
protected OwSplitObjectListDocument createSplitObjectListDocument(String[] splitNames, Collection<OwFieldColumnInfo>[] propertyColumnInfos, List<OwDocumentFunction> documentFunctions)
splitNames
- String array of Labels (display names) for the list view(s)propertyColumnInfos
- Collection of FieldColumnInfo objectsdocumentFunctions
- List of document functions (can be null)protected Collection<OwFieldColumnInfo> createRelationColumnInfo(OwObjectLinkRelation relation) throws Exception
Attention: If columns are defined for any relation kind, the same columns will be displayed.
relation
- OwObjectLinkRelation objects which will be rendered.Exception
public String getFilterDisplayName()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.