com.wewebu.ow.server.app
Class OwAbstractToolExtension

java.lang.Object
  extended by com.wewebu.ow.server.app.OwAbstractToolExtension
All Implemented Interfaces:
OwToolExtension, OwToolViewItem

public abstract class OwAbstractToolExtension
extends Object
implements OwToolExtension, OwToolViewItem

A generic extension of the tool item.
Implements the common configuration issues for an extension. Extension title and description can be localized by using the following constructions in ow_localize_?? files:

where the <extension_id> is the configured id for the extension, in ow_plugins.xml file.

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

Since:
3.1.0.0

Field Summary
protected static String DESCRIPTION_SUFFIX
          description suffix
protected static String EXTENSION_PREFIX
          extension prefix
protected  String m_bigIcon
          the big icon path (default or the configured path)
protected  OwXMLUtil m_confignode
          the configuration node
protected  OwMainAppContext m_context
          the application context
protected  String m_description
          the description
protected  String m_icon
          the icon path (default or the configured path)
protected  String m_id
          the extension id
protected  String m_jspForm
          the path to the JSP file
protected  String m_title
          the title
protected static String TITLE_SUFFIX
          title suffix
 
Constructor Summary
OwAbstractToolExtension()
           
 
Method Summary
 String getBigIcon()
          Get a big-icon for the tool to display.
protected abstract  String getDefaultBigIcon()
          Get the default big icon path.
protected  String getDefaultDescription()
          Get the default description for this extension.
protected abstract  String getDefaultIcon()
          Get the default icon, if nothing is configured
protected  String getDefaultId()
          Returns the default id for this extension.
protected  String getDefaultTitle()
          Gets the default title for this extension.
 String getDescription()
          Get a description for the tool to display.
 String getIcon()
          Get an icon for the tool to display.
 String getId()
          Get the extension id.
 String getTitle()
          Get a title for the tool to display.
 void init(OwXMLUtil confignode_p, OwMainAppContext context_p)
          Initializes the extension.
 
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.app.OwToolExtension
onClickEvent
 

Field Detail

EXTENSION_PREFIX

protected static final String EXTENSION_PREFIX
extension prefix

See Also:
Constant Field Values

DESCRIPTION_SUFFIX

protected static final String DESCRIPTION_SUFFIX
description suffix

See Also:
Constant Field Values

TITLE_SUFFIX

protected static final String TITLE_SUFFIX
title suffix

See Also:
Constant Field Values

m_context

protected OwMainAppContext m_context
the application context


m_confignode

protected OwXMLUtil m_confignode
the configuration node


m_icon

protected String m_icon
the icon path (default or the configured path)


m_bigIcon

protected String m_bigIcon
the big icon path (default or the configured path)


m_title

protected String m_title
the title


m_description

protected String m_description
the description


m_jspForm

protected String m_jspForm
the path to the JSP file


m_id

protected String m_id
the extension id

Constructor Detail

OwAbstractToolExtension

public OwAbstractToolExtension()
Method Detail

init

public void init(OwXMLUtil confignode_p,
                 OwMainAppContext context_p)
          throws Exception
Description copied from interface: OwToolExtension
Initializes the extension.

Specified by:
init in interface OwToolExtension
Parameters:
confignode_p - the configuration node
context_p - the current context
Throws:
Exception

getDefaultDescription

protected String getDefaultDescription()
Get the default description for this extension.

Returns:
- the default description for this extension.

getDefaultTitle

protected String getDefaultTitle()
Gets the default title for this extension.

Returns:
the default title for this extension.

getDefaultBigIcon

protected abstract String getDefaultBigIcon()
Get the default big icon path.

Returns:
- the default big icon path

getDefaultIcon

protected abstract String getDefaultIcon()
Get the default icon, if nothing is configured

Returns:
- the default icon path.

getDefaultId

protected String getDefaultId()
Returns the default id for this extension. Used for backward compatibility configuration

Returns:
- the default id.

getIcon

public String getIcon()
Description copied from interface: OwToolViewItem
Get an icon for the tool to display.

Specified by:
getIcon in interface OwToolViewItem
Returns:
String fully specified icon path

getBigIcon

public String getBigIcon()
Description copied from interface: OwToolViewItem
Get a big-icon for the tool to display.

Specified by:
getBigIcon in interface OwToolViewItem
Returns:
String fully specified icon path

getDescription

public String getDescription()
Description copied from interface: OwToolViewItem
Get a description for the tool to display.

Specified by:
getDescription in interface OwToolViewItem
Returns:
String

getTitle

public String getTitle()
Description copied from interface: OwToolViewItem
Get a title for the tool to display.

Specified by:
getTitle in interface OwToolViewItem
Returns:
String

getId

public String getId()
Description copied from interface: OwToolExtension
Get the extension id.

Specified by:
getId in interface OwToolExtension
Returns:
the extension id.


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.