public class OwShortCutDocument
extends com.wewebu.ow.server.app.OwMasterDocument
Short Cuts Document. Master plugin that displays and executes shortcuts.
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
Modifier and Type | Class and Description |
---|---|
protected static class |
OwShortCutDocument.OwSimpleShortCutContext
Simple implementation of OwShortCutItemContext interface.
|
Modifier and Type | Field and Description |
---|---|
protected int |
m_iMaxChildSize
maximum number of child nodes used in fetching relative path shortcuts
|
static String |
PLUGIN_CONFIG_MAXCHILDSIZE |
static String |
PLUGIN_CONFIG_SHORTCUT_FUNCTIONS
general ID in the plugin ID to be configure the plugin IDs for attachments
|
static String |
SETTINGS_PARAM_COLUMN_INFO
settings parameter name for the column info list for the node list view.
|
static String |
SETTINGS_PARAM_SORT
settings parameter name for the sorting.
|
Constructor and Description |
---|
OwShortCutDocument() |
Modifier and Type | Method and Description |
---|---|
void |
addEventListener(OwShortcutDocumentEventListner listener_p) |
void |
addOwObjectShortCut(com.wewebu.ow.server.ecm.OwObject object_p,
String path_p,
String subdisplaypath_p)
add new ShortCut to you ShrotCut(Favorites) List
|
void |
addOwObjectShortCuts(Collection objects_p)
Add new ShortCuts to you ShrotCut(Favorites) List
|
void |
addShortCuts(Collection shortcuts_p)
Add new ShortCuts to you ShrotCut(Favorites) List
|
protected OwShortCutDocumentHelper |
createShortCutHelper()
(overridable)
Factory method for the Helper.
|
void |
deleteShortCut(String id_p) |
void |
deleteShortCuts(List shortCutIds_p)
|
protected OwShortCutItem |
deserializeShortCut(String persistString,
OwShortCutItemContext context)
(overridable)
Factory method called to create an OwShortCutItem object from provided String.
If OwShortCut item cannot be instantiated from string a exception will be thrown. |
protected void |
fireShortcutDocumentChaged()
Triggers the
OwShortcutDocumentEventListner.onShortcutDocumentChaged(OwShortCutDocument)
event for all registered listeners. |
com.wewebu.ow.server.field.OwSort |
getColumnSortCriteria()
Get the column sort criteria.
Column sort criteria can be defined via <ColumnSortCriteria>
tag in owplugins.xml or Settings plugin.Double defined properties will be filtered out. |
Collection |
getDefaultColumnInfo()
get the default column info for the list of children if no column info is defined in the opened folder
|
protected Map |
getRepositories()
overridable, create a map of repositories that can be searched
|
protected OwShortCutDocumentHelper |
getShortCutDocumentHelper()
Getter to get helper for ShortCut handling.
|
List |
getShortcutFunctionIDs() |
protected OwShortCutItemContext |
getShortCutItemContext()
Get/Create OwShortCutItemContext
|
List |
getShortCutItems()
get list of OwShortCutItem
|
protected void |
init() |
void |
refreshShortcuts()
Refresh the list with shortcuts.
|
void |
removeEventListener(OwShortcutDocumentEventListner listener_p) |
dispatch, getConfigNode, getConfiguration, getMasterView, getPersistentAttributeBagWriteable, getPlugin, getPluginID, getSafeSetting, onDispatch, setPlugin, setSafeSetting
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute, update
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
public static final String PLUGIN_CONFIG_SHORTCUT_FUNCTIONS
public static final String PLUGIN_CONFIG_MAXCHILDSIZE
public static final String SETTINGS_PARAM_COLUMN_INFO
public static final String SETTINGS_PARAM_SORT
protected int m_iMaxChildSize
public void addOwObjectShortCuts(Collection objects_p) throws OwShortCutException
objects_p
- Collection of OwObject'sOwShortCutException
public void addOwObjectShortCut(com.wewebu.ow.server.ecm.OwObject object_p, String path_p, String subdisplaypath_p) throws OwShortCutException
object_p
- path_p
- subdisplaypath_p
- OwShortCutException
public void addShortCuts(Collection shortcuts_p) throws OwShortCutException
shortcuts_p
- Collection of OwShortCutItem'sOwShortCutException
public void deleteShortCut(String id_p) throws OwShortCutException
OwShortCutException
public void deleteShortCuts(List shortCutIds_p) throws OwShortCutException
shortCutIds_p
- lsit of shortcut IDs to deleteOwShortCutException
public List getShortCutItems() throws OwShortCutException
OwShortCutException
protected OwShortCutDocumentHelper getShortCutDocumentHelper() throws OwShortCutException
OwShortCutException
public List getShortcutFunctionIDs()
List
of document function IDs to be used with shortcuts pointing to OwObject
spublic com.wewebu.ow.server.field.OwSort getColumnSortCriteria() throws Exception
<ColumnSortCriteria>
tag in owplugins.xml
or Settings plugin.Exception
public Collection getDefaultColumnInfo() throws Exception
Exception
protected void init() throws Exception
init
in class com.wewebu.ow.server.app.OwMasterDocument
Exception
public void addEventListener(OwShortcutDocumentEventListner listener_p)
listener_p
- listener to be addedpublic void removeEventListener(OwShortcutDocumentEventListner listener_p)
listener_p
- listener to be removedprotected void fireShortcutDocumentChaged()
OwShortcutDocumentEventListner.onShortcutDocumentChaged(OwShortCutDocument)
event for all registered listeners.protected Map getRepositories()
public void refreshShortcuts() throws OwShortCutException
OwShortCutException
protected OwShortCutDocumentHelper createShortCutHelper()
protected OwShortCutItem deserializeShortCut(String persistString, OwShortCutItemContext context) throws com.wewebu.ow.server.exceptions.OwException
persistString
- String representing short cut item (favorite)context
- OwShortCutItemContext with references to AppContext and MIME managercom.wewebu.ow.server.exceptions.OwException
protected OwShortCutItemContext getShortCutItemContext()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.