P4UiComponentSummary - Revision history

TaniaTudorache at 06:10, May 24, 2016

2016-05-24T06:10:57Z

TaniaTudorache at 05:24, May 24, 2016

2016-05-24T05:24:29Z

Nickdrummond: /* OWL Frame lists */

2009-05-15T11:49:37Z

‎OWL Frame lists

Nickdrummond: Updated OWL components list

2009-05-06T15:28:19Z

Updated OWL components list

Nickdrummond: Added core components

2009-05-06T14:36:04Z

Added core components

New page

<div class="orangeBox">
<span class="orangeBoxTitle">P4 Developer Docs: UI Components</span><br /><br />
This page describes some of the more useful UI components available for P4 developers.
</div><br />

Back to [[Protege4DevDocs]]

__TOC__

== Packages ==

There are many standard UI components, as part of the core Protege framework and more specific components for managing OWL objects in the OWL editor kit.

All UI classes can be found in the following packages:
* [http://protege.stanford.edu/protege/4.0/docs/api/index.html?org/protege/editor/core/ui/package-summary.html org.protege.editor.core.ui] and its subpackages for core generic ui components
* [http://protege.stanford.edu/protege/4.0/docs/api/index.html?org/protege/editor/owl/ui/package-summary.html org.protege.editor.owl.ui] and its subpackages for owl specific ui components

== Components ==

=== Core components ===

==== Actions ====

Create menu items using a plugin mechanism (see [[PluginTypes#EditorKitMenuAction]] for details).

==== Errors ====

Display a dialog to the user when an exception needs to be reported.

use: '''org.protege.editor.core.ui.error.ErrorLogPanel'''

ErrorLogPanel.showErrorDialog(Exception e)

==== Lists ====

Protege-style JLists that have support for sections, and items with buttons on the right hand side for deleting, editing etc

implement: '''org.protege.editor.core.ui.list.MList'''
example: '''org.protege.editor.core.ui.list.RemovableObjectList'''

==== Preferences ====

Create preferences panels for your plugins (see [[PluginTypes#preferencespanel]] for details).

==== Wizards ====

A dialog with a series of pages to guide the user through a set of tasks with a certain set of steps.

implement: '''org.protege.editor.core.ui.wizard.Wizard'''
example: '''org.protege.editor.owl.ui.ontology.wizard.create.CreateOntologyWizard'''

==== Icons ====

Get a selection of icons that are found in the '''icons/''' folder in the core plugin.

Icons.getIcon("error.png")

==== Dialogs ====

Provides some handy static dialog/validating dialog (VerifyingOptionPane) creation methods.

use: '''org.protege.editor.core.ui.util.JOptionPaneEx'''

==== NativeBrowserLauncher ====

Show a url in the default native browser for the users OS.

NativeBrowserLauncher.openURL(String url);

==== ComponentFactory ====

Provides a series of static methods to create some standard Swing components with Protege default look and feel.

==== CheckTable ====

A table that supports selection checkboxes in the first column with a "check all" option

==== CheckList ====

==== File dialogs ====

Provides a number of native file selectors for loading or saving files.

use: '''org.protege.editor.core.ui.util.UIUtil'''

==== FilePathPanel/FileURIPanel ====

An editor with a built in file selection dialog (as used by Open ontology dialogs etc)

==== LinkLabel ====

A label that acts like a hyperlink

@@ Line 4: / Line 4: @@
 </div><br />
-Back to [[Protege4DevDocs]]
+'''Back to [[Main_Page#Developer_Documentation|Protege Developer Documentation]]'''
@@ Line 217: / Line 217: @@
 === CreateNewChild/SiblingTarget ===

@@ Line 138: / Line 138: @@
 ==== OWL Frame lists ====
 An extension of MList (see [[#Lists]] above) that contains axioms and provides additional functionality (such as right click items).
@@ Line 149: / Line 151: @@
 many examples of OWLFrameSections are available in '''org.protege.editor.owl.ui.frame'''
 ==== Views ====

@@ Line 1: / Line 1: @@
 <div class="orangeBox">
-<span class="orangeBoxTitle">P4 Developer Docs: UI Components</span><br /><br />
+<span class="orangeBoxTitle">Protege Developer Docs: UI Components</span><br /><br />
-This page describes some of the more useful UI components available for P4 developers.
+This page describes some of the more useful UI components available for developers working with Protege 4, 5 or newer versions.
 </div><br />

@@ Line 41: / Line 41: @@
 implement: '''org.protege.editor.core.ui.list.MList'''
 example: '''org.protege.editor.core.ui.list.RemovableObjectList'''
@@ Line 54: / Line 55: @@
 implement: '''org.protege.editor.core.ui.wizard.Wizard'''
 example: '''org.protege.editor.owl.ui.ontology.wizard.create.CreateOntologyWizard'''
@@ Line 106: / Line 108: @@
 A label that acts like a hyperlink