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:
<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
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
OwAbstractToolExtension() |
Modifier and Type | Method and Description |
---|---|
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
onClickEvent
protected static final String EXTENSION_PREFIX
protected static final String DESCRIPTION_SUFFIX
protected static final String TITLE_SUFFIX
protected OwMainAppContext m_context
protected OwXMLUtil m_confignode
protected String m_icon
protected String m_bigIcon
protected String m_title
protected String m_description
protected String m_jspForm
protected String m_id
public void init(OwXMLUtil confignode_p, OwMainAppContext context_p) throws Exception
OwToolExtension
init
in interface OwToolExtension
confignode_p
- the configuration nodecontext_p
- the current contextException
protected String getDefaultDescription()
protected String getDefaultTitle()
protected abstract String getDefaultBigIcon()
protected abstract String getDefaultIcon()
protected String getDefaultId()
public String getIcon()
OwToolViewItem
getIcon
in interface OwToolViewItem
public String getBigIcon()
OwToolViewItem
getBigIcon
in interface OwToolViewItem
public String getDescription()
OwToolViewItem
getDescription
in interface OwToolViewItem
public String getTitle()
OwToolViewItem
getTitle
in interface OwToolViewItem
public String getId()
OwToolExtension
getId
in interface OwToolExtension
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.