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

java.lang.Object
  extended by com.wewebu.ow.server.app.OwFunction
      extended by com.wewebu.ow.server.app.OwRecordFunction
          extended by com.wewebu.ow.server.plug.owshortcut.OwRecordFunctionShortcut
All Implemented Interfaces:
com.wewebu.ow.server.app.OwPlugin

public class OwRecordFunctionShortcut
extends com.wewebu.ow.server.app.OwRecordFunction

Move Record Function to move items from the clipboard.

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
static int INSERT_MODE_PHYSICALCOPY
          insert mode physical copy
static int INSERT_MODE_REFERENCE
          insert mode reference
 
Fields inherited from class com.wewebu.ow.server.app.OwFunction
DESCRIPTION_KEY_CLASSES, DESCRIPTION_KEY_OBJ_TYPES, DESCRIPTION_KEY_TYPE, DRAG_DROP_PROPERTY_MAX_FILESIZE, m_MainContext
 
Constructor Summary
OwRecordFunctionShortcut()
           
 
Method Summary
 String getBigIcon()
          get the URL to the info icon
 com.wewebu.ow.server.app.OwMasterDocument getFavoriteMasterPlugin()
          get the Bookmark/Favorite Master Plugin
 String getIcon()
          get the URL to the info icon
 void init(com.wewebu.ow.server.util.OwXMLUtil node_p, com.wewebu.ow.server.app.OwMainAppContext context_p)
          set the plugin description node
 boolean isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, int iContext_p)
          check if function is enabled for the given object parameters
 void onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p, com.wewebu.ow.server.ecm.OwObject folderObject_p, String subpath_p, String subdisplaypath_p, com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
          event called when user clicked the plugin label / icon
 
Methods inherited from class com.wewebu.ow.server.app.OwRecordFunction
addHistoryEvent, addHistoryEvent, getBigDefaultIconHTML, getBigIconHTML, getDefaultIconHTML, getDefaultLabel, getDragDropProperties, getIconHTML, getLabel, getPluginType, isDragDropTarget, isMultifileDragDropAllowed, onClickEvent
 
Methods inherited from class com.wewebu.ow.server.app.OwFunction
getConfigNode, getContext, getContextMenu, getEventManager, getHelpPath, getName, getNoEvent, getPluginID, getPluginTitle, getPluginTypeDisplayName, getSafeSetting, getSupportedObjectClassesFromDescriptor, getSupportedObjectTypesFromDescriptor, getTooltip, isObjectClassSupported, setSafeSetting
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INSERT_MODE_REFERENCE

public static final int INSERT_MODE_REFERENCE
insert mode reference

See Also:
Constant Field Values

INSERT_MODE_PHYSICALCOPY

public static final int INSERT_MODE_PHYSICALCOPY
insert mode physical copy

See Also:
Constant Field Values
Constructor Detail

OwRecordFunctionShortcut

public OwRecordFunctionShortcut()
Method Detail

init

public void init(com.wewebu.ow.server.util.OwXMLUtil node_p,
                 com.wewebu.ow.server.app.OwMainAppContext context_p)
          throws Exception
set the plugin description node

Overrides:
init in class com.wewebu.ow.server.app.OwRecordFunction
Parameters:
node_p - OwXMLUtil wrapped DOM Node containing the plugin description
context_p - OwMainAppContext
Throws:
Exception

getIcon

public String getIcon()
               throws Exception
get the URL to the info icon

Specified by:
getIcon in interface com.wewebu.ow.server.app.OwPlugin
Overrides:
getIcon in class com.wewebu.ow.server.app.OwFunction
Returns:
String URL
Throws:
Exception

getBigIcon

public String getBigIcon()
                  throws Exception
get the URL to the info icon

Overrides:
getBigIcon in class com.wewebu.ow.server.app.OwFunction
Returns:
String URL
Throws:
Exception

isEnabled

public boolean isEnabled(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                         com.wewebu.ow.server.ecm.OwObject folderObject_p,
                         int iContext_p)
                  throws Exception
check if function is enabled for the given object parameters

Overrides:
isEnabled in class com.wewebu.ow.server.app.OwRecordFunction
Parameters:
rootObject_p - OwObject root folder to work on
folderObject_p - OwObject selected folder to work on
Returns:
true = enabled, false otherwise
Throws:
Exception

onClickEvent

public void onClickEvent(com.wewebu.ow.server.ecm.OwObject rootObject_p,
                         com.wewebu.ow.server.ecm.OwObject folderObject_p,
                         String subpath_p,
                         String subdisplaypath_p,
                         com.wewebu.ow.server.app.OwClientRefreshContext refreshCtx_p)
                  throws Exception
event called when user clicked the plugin label / icon

Overrides:
onClickEvent in class com.wewebu.ow.server.app.OwRecordFunction
Parameters:
rootObject_p - OwObject root folder to work on
folderObject_p - OwObject selected folder to work on
subpath_p - String subpath of subfolder or null if root folder
subdisplaypath_p - String subpath of subfolder
refreshCtx_p - OwClientRefreshContext callback interface for the function plugins to signal refresh events to clients, can be null if no refresh is needed
Throws:
Exception

getFavoriteMasterPlugin

public com.wewebu.ow.server.app.OwMasterDocument getFavoriteMasterPlugin()
                                                                  throws com.wewebu.ow.server.exceptions.OwConfigurationException
get the Bookmark/Favorite Master Plugin

Returns:
the Bookmark/Favorite Master Plugin as OwMasterDocument
Throws:
com.wewebu.ow.server.exceptions.OwConfigurationException


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.