|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ATPlugin
Archivists' Toolkit(TM) Copyright 2005-2009 Regents of the University of California, New York University, & Five Colleges, Inc. All rights reserved. This software is free. You can redistribute it and / or modify it under the terms of the Educational Community License (ECL) version 1.0 (http://www.opensource.org/licenses/ecl1.php) This software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ECL license for more details about permissions and limitations. Archivists' Toolkit(TM) http://www.archiviststoolkit.org info@archiviststoolkit.org The simple plugin interface which all AT Plugins need to be implement in order to be loaded into the AT Created by IntelliJ IDEA.
Field Summary | |
---|---|
static java.lang.String |
ACCESSION_EDITOR
|
static java.lang.String |
ALL_EDITOR
|
static java.lang.String |
DEFAULT_CATEGORY
|
static java.lang.String |
DIGITALOBJECT_EDITOR
|
static java.lang.String |
EDITOR_CATEGORY
|
static java.lang.String |
IMPORT_CATEGORY
|
static java.lang.String |
NAME_EDITOR
|
static java.lang.String |
RESOURCE_EDITOR
|
static java.lang.String |
SUBJECT_EDITOR
|
static java.lang.String |
VIEWER_CATEGORY
|
Method Summary | |
---|---|
void |
doTask(java.lang.String task)
Method to do a specific task in the plugin. |
java.lang.String |
getCategory()
Method to get the category of the plugin i.e. |
java.lang.String |
getEditorType()
Method to return the type of domain objects this plugin can edit or view. |
javax.swing.JPanel |
getMainPanel()
Method to return the main jpanel for plugins that are not dialog or frames. |
java.lang.String |
getName()
Method to return the name of the plugin. |
java.lang.String[] |
getTaskList()
Method to get the list of specific task the plugin can perform. |
void |
setApplicationFrame(ApplicationFrame mainFrame)
Method to set the application frame. |
void |
setCallingTable(javax.swing.JTable callingTable)
Method to get the table from which the record was selected. |
void |
setModel(DomainObject domainObject,
InfiniteProgressPanel monitor)
Method to set the domain model. |
void |
setRecordPositionText(int recordNumber,
int totalRecords)
Method to set the current record number along with the total number of records |
void |
setSelectedRow(int selectedRow)
Method to set the selected row of the calling table. |
void |
showPlugin()
Method to display the plugin or do anything else the plugin requires when selected from the plugin or import menu, if it doesn't define a task list. |
void |
showPlugin(java.awt.Dialog owner)
Method to display a plugin that needs a parent dialog. |
void |
showPlugin(java.awt.Frame owner)
Method to display a plugin that needs a parent frame. |
Field Detail |
---|
static final java.lang.String DEFAULT_CATEGORY
static final java.lang.String IMPORT_CATEGORY
static final java.lang.String VIEWER_CATEGORY
static final java.lang.String EDITOR_CATEGORY
static final java.lang.String RESOURCE_EDITOR
static final java.lang.String DIGITALOBJECT_EDITOR
static final java.lang.String NAME_EDITOR
static final java.lang.String SUBJECT_EDITOR
static final java.lang.String ACCESSION_EDITOR
static final java.lang.String ALL_EDITOR
Method Detail |
---|
java.lang.String getCategory()
java.lang.String getName()
void setApplicationFrame(ApplicationFrame mainFrame)
mainFrame
- The main AT application framevoid showPlugin()
void showPlugin(java.awt.Frame owner)
owner
- The parent frame of this pluginvoid showPlugin(java.awt.Dialog owner)
owner
- The parent dialog of this pluginjavax.swing.JPanel getMainPanel()
void doTask(java.lang.String task)
task
- The task for the plugin to dojava.lang.String[] getTaskList()
java.lang.String getEditorType()
void setModel(DomainObject domainObject, InfiniteProgressPanel monitor)
domainObject
- The domain objectmonitor
- The progress monitorvoid setCallingTable(javax.swing.JTable callingTable)
callingTable
- The table containing the recordvoid setSelectedRow(int selectedRow)
selectedRow
- The selected rowvoid setRecordPositionText(int recordNumber, int totalRecords)
recordNumber
- The current record numbertotalRecords
- The total number of records
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |