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

JSDT Use Cases

Revision as of 16:06, 6 December 2007 by Childsb.us.ibm.com (Talk | contribs) (→‎Preference Pages)

JavaScript Development Toolkit (org.eclipse.wst.jsdt) Use Cases

Introduction

This page represents UI use cases for the WTP JavaScript (org.eclipse.wst.jsdt) editor in Eclipse. UI use cases may reference core behavior. Use case behavior is not necessarily implemented and serves as future UI direction. Not all existing UI behavior is documented here. If existing UI behavior should be removed, please add the current behavior in an appropriate section then use the <strike></strike> HTML tags to indicate desired removal.

UI Use Cases

Views

Package Explorer

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

  • JSDT should display each projects defined libraries. One top level entry immediately below each project called "JavaScript Scope" will house all of the projects libraries. User can expand the "JavaScript Scope" entry to display a list of the projects libraries.
  • 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 source code definition file in a read-only editor.
  • The user may double click a type, field or method to open its specific definition within the library source files.
  • 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 JavaScript Scope entry it should take them to the Library configuration property menu
  • If a project is not JSDT enabled the JavaScript 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 routine.
  • Project Explorer should show each library at the same level as the projects files

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

For every project with JSDT enabled in the 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 source code 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 JavaScript Scope entry it should take them to the Libray configuation property menu
  • If a project is not JSDT enabled the JavaScript 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.
  • Project Explorer should show each library at the same level as the projects files

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 will not have specific JavaScript UI contributions.

Preference Pages

  • JSDT will have 5 primary contributions to the Preference Pages - "JavaScript Code Style", "JavaScript Editor", "JavaScript Validator", "JavaScript Include Path", "JsDoc Location"
  • JSDT will have 2 primary contributions to the main preference page list: JavaScript and JavaScript Libraries.
  • The JavaScript Preference page will hold all current and future JSDT preference pages besides the JavaScript Libraries Preference Page. It will have four main sub pages: "JavaScript Code Style", "JavaScript Editor", "JavaScript Validator", "JsDoc Location".
  • The JavaScript Libraries preference page will be a per-project definition of the JavaScript libraries.
  • The JavaScript Libraries preference page will hold JavaScript Toolkit Add/Remove support option.
  • The JavaScript preference page will hold the JavaScript toolkit source location configuration page.

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.
Retrieved from "https://wiki.eclipse.org/index.php?title=JSDT_Use_Cases&oldid=66967"

Back to the top