|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wewebu.ow.server.ui.OwEventTarget
com.wewebu.ow.server.ui.OwView
com.wewebu.ow.server.dmsdialogs.views.OwObjectListView
com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewThumbnails
public class OwObjectListViewThumbnails
Object list view. Displays the results of searches.
Use setObjectList and setColumnInfo to set the objects and columns to display.
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
Nested Class Summary | |
---|---|
protected class |
OwObjectListViewThumbnails.ThumbnailTypeConfig
configdata of thumbnail type |
Nested classes/interfaces inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView |
---|
OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry |
Field Summary | |
---|---|
static int |
CONTEXT_MENU
|
static int |
DEFAULT_THUMBS_PER_ROW
|
protected Collection |
m_ColumnInfoList
a list of column info, which describe the columns of the object list |
protected int |
m_iCurrentPage
current zero based page number in multiples of getPageSize() for paging the results |
protected OwMainAppContext |
m_MainContext
reference to the cast AppContext |
protected OwMimeManager |
m_MimeManager
instance of the MIME manager used to open the objects |
protected OwClientRefreshContext |
m_RefreshContext
event listener for the function plugin refresh events |
protected OwSort |
m_Sort
the list with the sort criteria |
protected OwFieldManager |
m_theFieldManager
instance of the property field class |
protected ArrayList<OwObjectListViewThumbnails.ThumbnailTypeConfig> |
m_ThumbnailTypes
list of thumbnail types |
protected boolean |
m_useContextMenu
flag indicating if context menu should be shown |
protected int |
MAX_THUMBNAIL_PER_ROW
how many thumbnails should be display per row |
static int |
PAGE_BUTTONS
|
static int |
THUMBNAIL_LIST
|
static String |
VIEWER_SERVLET_REPLACE_TOKEN_BASEURL
token in the viewer servlet to be replaced by the base URL of the server with application context |
static String |
VIEWER_SERVLET_REPLACE_TOKEN_DMSID
token in the viewer servlet to be replaced by the DMSID |
static char |
VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_ENCODE_CHAR
char to indicate encoding of given property |
static String |
VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_END
token in the viewer servlet to be replaced by the property end delimiter |
static char |
VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_NOENCODE_CHAR
char to indicate NO encoding of given property |
static String |
VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_START
token in the viewer servlet to be replaced by the property following the : |
static String |
VIEWER_SERVLET_REPLACE_TOKEN_SERVERURL
token in the viewer servlet to be replaced by the base URL of the server |
Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView |
---|
m_HtmlAlignments, m_isStickyFooterInUse, m_pageSelectorComponent, m_pagingNode, MULTISELECT_COMOBO_MENU_NAME, OBJECT_INDEX_KEY, PLUG_INDEX_KEY, QUERY_KEY_PAGE, SORT_PROPERTY_KEY, VIEW_MASK_INLINE_EDITING, VIEW_MASK_INSTANCE_PLUGINS, VIEW_MASK_MULTI_SELECTION, VIEW_MASK_NO_PAGE_BUTTONS, VIEW_MASK_SINGLE_SELECTION, VIEW_MASK_USE_DOCUMENT_PLUGINS, VIEW_MASK_USE_SELECT_BUTTON |
Fields inherited from class com.wewebu.ow.server.ui.OwView |
---|
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget |
Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider |
---|
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL |
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView |
---|
EMPTY_STRING |
Constructor Summary | |
---|---|
OwObjectListViewThumbnails()
construct a object list view |
|
OwObjectListViewThumbnails(int iViewMask_p)
construct a object list view |
Method Summary | |
---|---|
boolean |
canPageNext()
check if there is a next page |
boolean |
canPagePrev()
check if there is a previous page |
void |
detach()
remove view and all subviews from context |
Collection |
getColumnInfo()
get the list of column info to be used by this list view |
int |
getCount()
get number of items in the list |
int |
getCurrentPage()
get current zero based page number in multiples of getPageSize() |
OwField |
getField(String strFieldClassName_p)
get a field with the given field definition class name |
OwFieldManager |
getFieldManager()
get the internal fieldmanager |
String |
getFieldProviderName()
get a name that identifies the field provider, e.g. |
Object |
getFieldProviderSource()
get the source object that originally provided the fields. |
int |
getFieldProviderType()
get the type of field provider can be one or more of TYPE_... |
Collection |
getFields()
get all the properties in the form |
protected String |
getHtmlAlignment(int iAlignment_p)
method to retrieve HTML alignment attributes out of OwFieldColumnInfo alignment |
String |
getIcon()
get the icon URL for this view to be displayed |
boolean |
getIsList()
|
boolean |
getIsListValid()
|
OwObjectCollection |
getObjectList()
get the current object list |
int |
getPageCount()
retrieve number of available pages |
protected OwClientRefreshContext |
getRefreshContext()
get an eventlistener with this view to receive notifications |
Collection |
getRetrievalPropertyNames()
get a collection of property names that are needed to display the Objects in the list i.e. |
Object |
getSafeFieldValue(String sName_p,
Object defaultvalue_p)
retrieve the value of a Field |
OwSort |
getSort()
get the current selected sort instance |
protected String |
getThumbnailRowId(int idx_p,
int line_p)
Get Thumbnail RowId |
int |
getThumbnailTypeCount()
|
String |
getThumbnailTypeDisplayName(int i_p)
|
String |
getThumbnailTypeUrl(int i_p)
|
String |
getTitle()
overridable title of the view |
protected void |
init()
Initialize the view after the context is set. |
protected void |
insertDocumentFunctionPlugins(Writer w_p,
OwObject obj_p,
int iIndex_p,
Collection instancePluginsList_p)
insert the document function plugins for the requested row index and object |
protected boolean |
isPagingEnabled()
check if paging is enabled |
boolean |
isRegion(int iRegion_p)
determine if region exists |
void |
onAjaxPersistSelection(javax.servlet.http.HttpServletRequest request_p,
javax.servlet.http.HttpServletResponse response_p)
Called upon AJAX request "PersistSelection" |
void |
onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin column |
void |
onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin link on the context menu |
void |
onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user submitted the multi select form |
void |
onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
display absolute page of objects |
void |
onPageNext(javax.servlet.http.HttpServletRequest request_p)
display next page of objects |
void |
onPagePrev(javax.servlet.http.HttpServletRequest request_p)
display previous page of objects |
void |
onPluginEvent(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked on a plugin link of an object entry in the list |
protected void |
onRender(Writer w_p)
render the view |
void |
onSelect(javax.servlet.http.HttpServletRequest request_p)
event called when user selected an item |
void |
onSort(javax.servlet.http.HttpServletRequest request_p)
event called when user clicked a sort header |
protected void |
pageAbsolut(int iPage_p)
move to the given zero based absolute page |
protected void |
renderBlockBegin(int startIndexPosition_p,
int currentPosition_p,
StringWriter w_p)
Render block begin. |
protected void |
renderBlockEnd(int startIndexPosition_p,
int endIndexPosition_p,
int currentPosition_p,
StringWriter w_p)
Render block end |
protected void |
renderPageButtons(Writer w_p)
render the paging buttons |
void |
renderRegion(Writer w_p,
int iRegion_p)
render only a region in the view, used by derived classes |
protected Set |
renderThumbnails(Writer w_p,
Collection instancePluginsList_p)
render the header portion of the object list |
protected static String |
replaceProperties(OwMainAppContext context_p,
String strIn_p,
OwObjectReference obj_p)
replace a object property placeholder |
void |
setColumnInfo(Collection columnInfo_p)
set the list of column info to be used by this list view |
void |
setConfigNode(Node node_p)
optional use the default constructor and set a config node to configure the view with XML This may override the settings in the ViewMaks, see setViewMask |
void |
setField(String sName_p,
Object value_p)
modify a Field value, but does not save the value right away |
void |
setFieldManager(OwFieldManager fielmanager_p)
set the internal fieldmanager in case you want a specific fieldmanager |
void |
setObjectList(OwObjectCollection objectList_p,
OwObject parentObject_p)
set the list of objects to be displayed by this list view |
void |
setRefreshContext(OwClientRefreshContext eventlister_p)
register an eventlistener with this view to receive notifications |
void |
setSort(OwSort sort_p)
set / override current sort to given sort |
boolean |
updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p,
boolean fSave_p)
update the target after a form event, so it can set its form fields |
protected String |
usesFormWithAttributes()
to get additional form attributes used for the form override if your view needs a form. |
Methods inherited from class com.wewebu.ow.server.ui.OwView |
---|
activate, addView, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onActivate, onUpdate, render, renderHTMLFormular, renderNamedRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal |
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget |
---|
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.wewebu.ow.server.dmsdialogs.views.OwPageableView |
---|
getContext |
Methods inherited from interface com.wewebu.ow.server.ui.OwBaseView |
---|
getBreadcrumbPart, isNamedRegion, render, renderNamedRegion |
Field Detail |
---|
public static final int DEFAULT_THUMBS_PER_ROW
protected OwMainAppContext m_MainContext
protected int m_iCurrentPage
protected int MAX_THUMBNAIL_PER_ROW
public static final String VIEWER_SERVLET_REPLACE_TOKEN_DMSID
public static final String VIEWER_SERVLET_REPLACE_TOKEN_SERVERURL
public static final String VIEWER_SERVLET_REPLACE_TOKEN_BASEURL
public static final String VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_START
public static final char VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_ENCODE_CHAR
public static final char VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_NOENCODE_CHAR
public static final String VIEWER_SERVLET_REPLACE_TOKEN_PROPERTY_END
protected OwSort m_Sort
protected boolean m_useContextMenu
protected OwMimeManager m_MimeManager
protected Collection m_ColumnInfoList
protected OwFieldManager m_theFieldManager
protected OwClientRefreshContext m_RefreshContext
public static final int THUMBNAIL_LIST
public static final int CONTEXT_MENU
public static final int PAGE_BUTTONS
protected ArrayList<OwObjectListViewThumbnails.ThumbnailTypeConfig> m_ThumbnailTypes
Constructor Detail |
---|
public OwObjectListViewThumbnails(int iViewMask_p)
iViewMask_p
- int combination of VIEW_MASK_... defined flagspublic OwObjectListViewThumbnails()
Method Detail |
---|
public boolean getIsList()
public boolean getIsListValid()
public void setConfigNode(Node node_p) throws Exception
setConfigNode
in class OwObjectListView
node_p
- XML node with configuration information
Exception
protected static String replaceProperties(OwMainAppContext context_p, String strIn_p, OwObjectReference obj_p) throws Exception
strIn_p
- String to search and replaceobj_p
- OwObjectReference
Exception
protected String getHtmlAlignment(int iAlignment_p)
iAlignment_p
- int alignment as defined in OwFieldColumnInfo
public void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
setObjectList
in class OwObjectListView
objectList_p
- OwObjectCollectionparentObject_p
- OwObject parent which created the object list, can be null if no parent is specified
Exception
protected String usesFormWithAttributes()
usesFormWithAttributes
in class OwView
public OwObjectCollection getObjectList()
getObjectList
in class OwObjectListView
protected boolean isPagingEnabled()
isPagingEnabled
in class OwObjectListView
public int getPageCount() throws Exception
getPageCount
in interface OwPageableView
getPageCount
in class OwObjectListView
Exception
public int getCurrentPage()
getCurrentPage
in interface OwPageableView
getCurrentPage
in class OwObjectListView
public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPageAbsolut
in interface OwPageableView
onPageAbsolut
in class OwObjectListView
Exception
OwPageableView.onPageAbsolut(javax.servlet.http.HttpServletRequest)
protected void pageAbsolut(int iPage_p) throws Exception
pageAbsolut
in class OwObjectListView
iPage_p
- int zero based page number in multiples of getPageSize()
Exception
public void onPageNext(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPageNext
in interface OwPageableView
onPageNext
in class OwObjectListView
Exception
OwPageableView.onPageNext(javax.servlet.http.HttpServletRequest)
public void onPagePrev(javax.servlet.http.HttpServletRequest request_p) throws Exception
onPagePrev
in interface OwPageableView
onPagePrev
in class OwObjectListView
Exception
OwPageableView.onPagePrev(javax.servlet.http.HttpServletRequest)
public boolean canPagePrev()
canPagePrev
in interface OwPageableView
canPagePrev
in class OwObjectListView
public boolean canPageNext() throws Exception
canPageNext
in interface OwPageableView
canPageNext
in class OwObjectListView
Exception
public OwFieldManager getFieldManager()
getFieldManager
in class OwObjectListView
public void setFieldManager(OwFieldManager fielmanager_p)
setFieldManager
in class OwObjectListView
public void setRefreshContext(OwClientRefreshContext eventlister_p)
setRefreshContext
in class OwObjectListView
eventlister_p
- OwClientRefreshContext interfaceprotected OwClientRefreshContext getRefreshContext()
getRefreshContext
in class OwObjectListView
public int getCount()
getCount
in interface OwPageableView
getCount
in class OwObjectListView
public void setColumnInfo(Collection columnInfo_p)
setColumnInfo
in class OwObjectListView
columnInfo_p
- List of OwFieldColumnInfo'spublic Collection getColumnInfo()
getColumnInfo
in class OwObjectListView
protected void init() throws Exception
init
in class OwObjectListView
Exception
public void setSort(OwSort sort_p)
setSort
in class OwObjectListView
sort_p
- new OwSortpublic OwSort getSort()
getSort
in class OwObjectListView
public void detach()
detach
in class OwView
protected String getThumbnailRowId(int idx_p, int line_p)
idx_p
- intline_p
- int
String
protected Set renderThumbnails(Writer w_p, Collection instancePluginsList_p) throws Exception
w_p
- Writer object to write HTML toinstancePluginsList_p
- Collection of plugins that are displayed for each instance
Exception
protected void renderBlockEnd(int startIndexPosition_p, int endIndexPosition_p, int currentPosition_p, StringWriter w_p)
startIndexPosition_p
- - the starting position in object list.endIndexPosition_p
- - the ending position in object listcurrentPosition_p
- - the current position in object listw_p
- - the writer objectprotected void renderBlockBegin(int startIndexPosition_p, int currentPosition_p, StringWriter w_p)
startIndexPosition_p
- - starting position in object list.currentPosition_p
- - current position in object list.w_p
- - the writer objectpublic boolean isRegion(int iRegion_p) throws Exception
isRegion
in interface OwBaseView
isRegion
in class OwView
iRegion_p
- ID of the region to render
Exception
public void renderRegion(Writer w_p, int iRegion_p) throws Exception
renderRegion
in interface OwBaseView
renderRegion
in class OwView
w_p
- Writer object to write HTML toiRegion_p
- ID of the region to render
Exception
public String getThumbnailTypeDisplayName(int i_p)
public int getThumbnailTypeCount()
public String getThumbnailTypeUrl(int i_p)
protected void onRender(Writer w_p) throws Exception
onRender
in class OwView
w_p
- Writer object to write HTML to
Exception
public void onAjaxPersistSelection(javax.servlet.http.HttpServletRequest request_p, javax.servlet.http.HttpServletResponse response_p) throws Exception
request_p
- response_p
-
Exception
protected void renderPageButtons(Writer w_p) throws Exception
w_p
- Writer object to write HTML to
Exception
protected void insertDocumentFunctionPlugins(Writer w_p, OwObject obj_p, int iIndex_p, Collection instancePluginsList_p) throws Exception
w_p
- writer object for HTML outputobj_p
- OwObject to create Function plugin foriIndex_p
- the row / object indexinstancePluginsList_p
- Collection of plugins that are visible (have there own column) together with the global index
Exception
public void onSort(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onContextMenuEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onColumnClickEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onMultiSelectEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onPluginEvent(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public void onSelect(javax.servlet.http.HttpServletRequest request_p) throws Exception
request_p
- HttpServletRequest
Exception
public boolean updateExternalFormTarget(javax.servlet.http.HttpServletRequest request_p, boolean fSave_p) throws Exception
updateExternalFormTarget
in class OwEventTarget
request_p
- HttpServletRequestfSave_p
- boolean true = save the changes of the form data, false = just update the form data, but do not save
Exception
public Collection getRetrievalPropertyNames() throws Exception
getRetrievalPropertyNames
in class OwObjectListView
Exception
public OwField getField(String strFieldClassName_p) throws Exception, OwObjectNotFoundException
OwFieldProvider
getField
in interface OwFieldProvider
strFieldClassName_p
- String class name of requested fields
Exception
OwObjectNotFoundException
public int getFieldProviderType()
OwFieldProvider
getFieldProviderType
in interface OwFieldProvider
public Object getFieldProviderSource()
OwFieldProvider
getFieldProviderSource
in interface OwFieldProvider
public String getFieldProviderName()
OwFieldProvider
getFieldProviderName
in interface OwFieldProvider
public void setField(String sName_p, Object value_p) throws Exception, OwObjectNotFoundException
setField
in interface OwFieldProvider
sName_p
- value_p
-
Exception
OwObjectNotFoundException
public Object getSafeFieldValue(String sName_p, Object defaultvalue_p)
getSafeFieldValue
in interface OwFieldProvider
sName_p
- defaultvalue_p
-
public Collection getFields() throws Exception
getFields
in interface OwFieldProvider
Exception
public String getTitle()
getTitle
in interface OwBaseView
getTitle
in class OwView
public String getIcon() throws Exception
getIcon
in class OwView
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |