com.wewebu.ow.server.plug.owshortcut
Class OwShortCutDocument

java.lang.Object
  extended by com.wewebu.ow.server.ui.OwEventTarget
      extended by com.wewebu.ow.server.ui.OwDocument
          extended by com.wewebu.ow.server.app.OwMasterDocument
              extended by com.wewebu.ow.server.plug.owshortcut.OwShortCutDocument
All Implemented Interfaces:
com.wewebu.ow.server.util.OwAttributeBag, com.wewebu.ow.server.util.OwAttributeBagWriteable

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


Field Summary
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.
 
Fields inherited from class com.wewebu.ow.server.ui.OwDocument
m_ViewList
 
Constructor Summary
OwShortCutDocument()
           
 
Method Summary
 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)
          Delete ShortCuts from your ShortCut(Favorites) List by indexes found in the given List as Strings
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
 List getShortcutFunctionIDs()
           
 List getShortCutItems()
          get list of OwShortCutItem
protected  void init()
           
 void refreshShortcuts()
          Refresh the list with shortcuts.
 void removeEventListener(OwShortcutDocumentEventListner listener_p)
           
 
Methods inherited from class com.wewebu.ow.server.app.OwMasterDocument
dispatch, getConfigNode, getConfiguration, getMasterView, getPersistentAttributeBagWriteable, getPlugin, getPluginID, getSafeSetting, onDispatch, setPlugin, setSafeSetting
 
Methods inherited from class com.wewebu.ow.server.ui.OwDocument
attachView, attributecount, clear, detachView, getAttribute, getAttribute, getAttributeNames, getSafeAttribute, hasAttribute, remove, save, setAttribute, update
 
Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget
attach, detach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getFormName, getFormTarget, getID, onExternalRequest, onFormEvent, onRequest, setExternalFormTarget, updateExternalFormTarget
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PLUGIN_CONFIG_SHORTCUT_FUNCTIONS

public static final String PLUGIN_CONFIG_SHORTCUT_FUNCTIONS
general ID in the plugin ID to be configure the plugin IDs for attachments

See Also:
Constant Field Values

PLUGIN_CONFIG_MAXCHILDSIZE

public static final String PLUGIN_CONFIG_MAXCHILDSIZE
See Also:
Constant Field Values

SETTINGS_PARAM_COLUMN_INFO

public static final String SETTINGS_PARAM_COLUMN_INFO
settings parameter name for the column info list for the node list view.

See Also:
Constant Field Values

SETTINGS_PARAM_SORT

public static final String SETTINGS_PARAM_SORT
settings parameter name for the sorting.

See Also:
Constant Field Values

m_iMaxChildSize

protected int m_iMaxChildSize
maximum number of child nodes used in fetching relative path shortcuts

Constructor Detail

OwShortCutDocument

public OwShortCutDocument()
Method Detail

addOwObjectShortCuts

public void addOwObjectShortCuts(Collection objects_p)
                          throws OwShortCutException
Add new ShortCuts to you ShrotCut(Favorites) List

Parameters:
objects_p - Collection of OwObject's
Throws:
OwShortCutException

addOwObjectShortCut

public void addOwObjectShortCut(com.wewebu.ow.server.ecm.OwObject object_p,
                                String path_p,
                                String subdisplaypath_p)
                         throws OwShortCutException
add new ShortCut to you ShrotCut(Favorites) List

Parameters:
object_p -
path_p -
subdisplaypath_p -
Throws:
OwShortCutException

addShortCuts

public void addShortCuts(Collection shortcuts_p)
                  throws OwShortCutException
Add new ShortCuts to you ShrotCut(Favorites) List

Parameters:
shortcuts_p - Collection of OwShortCutItem's
Throws:
OwShortCutException

deleteShortCut

public void deleteShortCut(String id_p)
                    throws OwShortCutException
Throws:
OwShortCutException

deleteShortCuts

public void deleteShortCuts(List shortCutIds_p)
                     throws OwShortCutException
Delete ShortCuts from your ShortCut(Favorites) List by indexes found in the given List as Strings

Parameters:
shortCutIds_p - lsit of shortcut IDs to delete
Throws:
OwShortCutException
Since:
2.5.3.0

getShortCutItems

public List getShortCutItems()
                      throws OwShortCutException
get list of OwShortCutItem

Throws:
OwShortCutException

getShortcutFunctionIDs

public List getShortcutFunctionIDs()
Returns:
a List of document function IDs to be used with shortcuts pointing to OwObjects
Since:
2.5.3.0

getColumnSortCriteria

public com.wewebu.ow.server.field.OwSort getColumnSortCriteria()
                                                        throws Exception
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.

Returns:
List of OwSortCriteria
Throws:
Exception
Since:
2.5.3.0

getDefaultColumnInfo

public Collection getDefaultColumnInfo()
                                throws Exception
get the default column info for the list of children if no column info is defined in the opened folder

Throws:
Exception
Since:
2.5.3.0

init

protected void init()
             throws Exception
Overrides:
init in class com.wewebu.ow.server.app.OwMasterDocument
Throws:
Exception

addEventListener

public void addEventListener(OwShortcutDocumentEventListner listener_p)
Parameters:
listener_p - listener to be added
Since:
2.5.3.0

removeEventListener

public void removeEventListener(OwShortcutDocumentEventListner listener_p)
Parameters:
listener_p - listener to be removed
Since:
2.5.3.0

fireShortcutDocumentChaged

protected void fireShortcutDocumentChaged()
Triggers the OwShortcutDocumentEventListner.onShortcutDocumentChaged(OwShortCutDocument) event for all registered listeners.

Since:
2.5.3.0

getRepositories

protected Map getRepositories()
overridable, create a map of repositories that can be searched


refreshShortcuts

public void refreshShortcuts()
                      throws OwShortCutException
Refresh the list with shortcuts.

Throws:
OwShortCutException
Since:
3.1.0.3

createShortCutHelper

protected OwShortCutDocumentHelper createShortCutHelper()
(overridable) Factory method for the Helper.

Returns:
OwShortCutDocumentHelper
Since:
3.2.0.4

deserializeShortCut

protected OwShortCutItem deserializeShortCut(String persistString,
                                             OwShortCutItemContext context)
                                      throws com.wewebu.ow.server.exceptions.OwException
(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.

Parameters:
persistString - String representing short cut item (favorite)
context - OwShortCutItemContext with references to AppContext and MIME manager
Returns:
OwShortCutItem
Throws:
com.wewebu.ow.server.exceptions.OwException
Since:
3.2.0.4


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.