Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "JSDT Use Cases"

(Package Explorer)
(JavaScript WTP Use Cases)
Line 10: Line 10:
  
 
'''For every project with JSDT enabled in the Package Explorer View:'''
 
'''For every project with JSDT enabled in the Package Explorer View:'''
* JSDT should display each projects defined libraries.  The entry at the same level as the proejct's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
+
* JSDT should display each projects defined libraries.  The entry at the same level as the project's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
 
* The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
 
* The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
 
* The user may double click a library to open its definition file in a read-only editor.
 
* The user may double click a library to open its definition file in a read-only editor.
 
* The user may right click on a library entry to display a context menu to remove the library from the Global Scope.
 
* The user may right click on a library entry to display a context menu to remove the library from the Global Scope.
* If the user double clicks the high level Global Scope entry it should take them to the Libray configuation property menu
+
* If the user double clicks the high level Global Scope entry it should take them to the Library configuration property menu
 
* If a project is not JSDT enabled the Global scope entry (and any library entries) is not visible.
 
* If a project is not JSDT enabled the Global scope entry (and any library entries) is not visible.
 
* A context menu item is added to non-JSDT projects to add JSDT support.  This will invoke JSDT project setup.
 
* A context menu item is added to non-JSDT projects to add JSDT support.  This will invoke JSDT project setup.
Line 21: Line 21:
  
 
==== Script Explorer View ====
 
==== Script Explorer View ====
* JSDT should display each projects defined libraries.  The entry at the same level as the proejct's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
+
* JSDT should display each projects defined libraries.  The entry at the same level as the project's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
 
* The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
 
* The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
 
* The user may double click a library to open its definition file in a read-only editor.
 
* The user may double click a library to open its definition file in a read-only editor.
Line 44: Line 44:
 
* JavaScript fields, types and functions will be shows under the respective script node subsections of the HTML editors content outline where they are defined.
 
* JavaScript fields, types and functions will be shows under the respective script node subsections of the HTML editors content outline where they are defined.
 
* The HTML editor JavaScript nodes will provide some soure and refactoring context menus.
 
* The HTML editor JavaScript nodes will provide some soure and refactoring context menus.
 +
=== Project Context Menu ===
 +
* All JavaScript context menu contributions will be grouped under one main menu item called "Web Development Tools".
 +
* Projects without JSDT enabled will have the "Enable JSDT Support" menu item under "Web Development Tools"
 +
* Projects with JSDT enabled will have an "Add/Remove JavaScript Toolkits" context menu item under "Web Development Tools" that displays the Add/Remove JavaScript toolkit page.  Users can then add/remove Dojo,Rico, Prototype toolkits.

Revision as of 15:14, 6 December 2007

JavaScript WTP Use Cases

Introduction

This page represents UI use cases for the WTP JavaScript (org.eclipse.wst.jsdt) editor in Eclipse. Currently no core use cases are defined. UI use cases may reference core behavior. Use case behavior is not necessarily implemented and serves as future UI direction. Not all current UI behavior is documented here either.

UI Use Cases

Views

Package Explorer

For every project with JSDT enabled in the Package Explorer View:

  • JSDT should display each projects defined libraries. The entry at the same level as the project's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
  • The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
  • The user may double click a library to open its definition file in a read-only editor.
  • The user may right click on a library entry to display a context menu to remove the library from the Global Scope.
  • If the user double clicks the high level Global Scope entry it should take them to the Library configuration property menu
  • If a project is not JSDT enabled the Global scope entry (and any library entries) is not visible.
  • A context menu item is added to non-JSDT projects to add JSDT support. This will invoke JSDT project setup.

For JavaScript only projects in the Package Explorer View:

  • The user can drill down into each individual JavaScript source files types and fields from the files entry in the Project Explorer.

Script Explorer View

  • JSDT should display each projects defined libraries. The entry at the same level as the project's files will display one entry called "JavaScript Scope" that may be expanded to display the projects library entries.
  • The user may continue drilling into the library entries under top-level JavaScript Scope to expose types within each library.
  • The user may double click a library to open its definition file in a read-only editor.
  • The user may right click on a library entry to display a context menu to remove the library from the Global Scope.
  • If the user double clicks the high level Global Scope entry it should take them to the Libray configuation property menu
  • If a project is not JSDT enabled the Global scope entry (and any library entries) is not visible.
  • A context menu item is added to non-JSDT projects to add JSDT support. This will invoke JSDT project setup.

For JavaScript only projects in the Package Explorer View:

  • The user can drill down into each individual JavaScript source files types and fields from the files entry in the Project Explorer.

Other Views

Any view not mentioned here not have specific JavaScript UI contributions.

Preference Pages

  • JSDT will have 2 primary contributions to the preference page main window: JavaScript and JavaScript Libraries.
  • The JavaScript Preference page will hold all current and future JavaScript editor preference pages.
  • The JavaScript libraries page will be a per-proejct definition of the JavaScript libraries.

Editor

Content Outline

  • JavaScript fields, types, and functions will be shown in the JavaScript editors content outline.
  • JavaScript fields, types and functions will be shows under the respective script node subsections of the HTML editors content outline where they are defined.
  • The HTML editor JavaScript nodes will provide some soure and refactoring context menus.

Project Context Menu

  • All JavaScript context menu contributions will be grouped under one main menu item called "Web Development Tools".
  • Projects without JSDT enabled will have the "Enable JSDT Support" menu item under "Web Development Tools"
  • Projects with JSDT enabled will have an "Add/Remove JavaScript Toolkits" context menu item under "Web Development Tools" that displays the Add/Remove JavaScript toolkit page. Users can then add/remove Dojo,Rico, Prototype toolkits.

Back to the top