NetBeans Update - UI spec

Author: Jindrich Dinga
Date: 07/17/05
Version: First draft

Content

  1. Introduction
  2. Usecases and Scenarios
  3. Update - UI design
    1. Automatic Update
    2. Update invoked manually
    3. Update Dialog Solution
    4. Other dialogs
  4. Options - UI design
  5. Position of NetBeans Update in Tools menu
  6. Related links

1. Introduction

This UI spec is divided into two parts: in the first part of the spec, there is Update proposal and the second part describes what can be found in Update Options.

2. Usecases and Scenarios

For usecases and scenarios click here.

3. Update - UI design

The proxy settings should be taken from the registers by default so there should not be any error caused by proxy. All of the dialogs below are modal.

3.1. Automatic Update

If the updating is started automatically, checking is posted to the background and it is hidden, it does not disturb users, no dialog pop ups.

  1. If there are no new updates on the Update Center no feedback should be displayed.
  2. If the wizard has found new updates, it should be announced to the user by displaying an icon (figure 1) in the right corner of the status line. This icon should stay there unless the user clicks on it (it invokes the update dialog - shows available updates). The tool tip should state: <Updates found. Click here to proceed with module selection.>.
  3. In case there is a problem during connection to the Update Center, it is announced by displaying an icon (figure 1) in the right corner of the status line. This icon should stay there unless the user clicks on it (it invokes a modal dialog - see figure 2). The tool tip should state: <Unable to connect to the Update Center. Click here for more details.>.
  4. Appropriate info e.g. "Checking for updates..." is displayed in the left part of status line (info area).

figure 1 - "Updates found" and "Unable to connect..." icons

3.2. Update invoked manually

If the updating is invoked by the user, the behavior of updating is:

1. Connection dialog is invoked.
2a. "Install Manually Downloaded Modules" option is selected: the user can installed modules manually
2b. "Check the NetBeans Update Center..." option is selected: If a problem occurs, it is announced to the user by a modal dialog (figure 2).

figure 2 - appearance of "Error" dialog

3. If any updates are found, the wizard should continue with its next step (shows available updates).

3.3. Update Dialog Solution

The Update dialog can be divided into two parts:

  1. Modules location
  2. Modules selection

1. Modules location

In this dialog (figure 3a) a user can select two options:

  1. "Check the NetBeans Update Center for Updates and New modules" will try to connect to the Update Center (figure 3b).
  2. "Install Manually Downloaded Modules (*.nbm files)" will bring the user to the Module selection dialog (figure 4), where only Local tab is available and selected by default.
figure 3a - appearance of "Modules location" dialog
figure 3b - connecting to the Update Center

2. Modules selection

In the Update dialog, there is possibility to select/deselect updates of already installed modules (Installed tab), new modules (Available tab) and add manually downloaded NBM's (Local tab). There is also Advertising area (can be a picture or picture as a link) - information about major releases, important service packs, etc. is displayed there. If there are no new information, some NetBeans picture can be displayed there.

At the beginning of starting NetBeans IDE, the user's rights (read only, read and write) should be found out. Two situations can happen:

  1. Rights are set up to read only (the user cannot install modules globally (share with others))
    • All modules can be installed only locally. If there are any modules which needs to be installed globally, they are displayed as disabled and a tool tip will state <This module must be installed globally. You do not, however, have the necessary permissions to do this. Please contact your administrator for assistance.> that the user does not have sufficient rights to install these modules (figures 4b).
    • The table has ten rows (for "Installed" and "Available" tabs, in "Local " tab there are eight rows) and four columns, all rows and columns are visible by default (if the columns visibility is changed, the new visibility becomes default). The number of columns can be modified by clicking on the top right icon in the table header, which opens "Visible Columns" customizer (figure 5). Name must be always visible.
    • All modules are sorted by Name in ascending order by default. The user can change the ordering by clicking on the table header - a sort indicator will appear then. Other possibilities for sorting are: by Version or by Size. The categories are colored by color used in property sheet (different color for different platforms), row selection uses appropriate color as well.
    • If the user does not want to update certain module, s/he unselects the checkbox in the "Installed" tab and this setting will remain there.
figure 4a - appearance of "Installed" tab
figure 4b - appearance of "Available" tab


figure 4c - appearance of "Local " tab
  • After pressing customizer icon, "Visible columns" customizer appears (figure 5).

figure 5 - appearance of "Visible Columns" customizer

  • Contextual menu is invokable on the list of modules and contains actions named below (figure 6).
- selects/deselects module (category) to be installed (for more than one selected module the <module name> is changed to <modules>)
- selects all modules to be installed
- deselects all modules to be installed

- sorts according to the column
- opens modal dialog (figure 5)
figure 6 - Contextual menu in NetBeans Update
  • Rights are set up to read and write (the user can install modules locally as well as globally (share with other users))
    • All modules can be installed locally as well as globally (figures 7a-c).
    • The table has ten rows (for "Installed" and "Available" tabs, in "Local " tab there are eight rows) and five columns, all rows and columns are visible by default (if the columns visibility is changed, the new visibility becomes default). The number of columns can be modified by clicking on the top right icon in the table header, which opens "Visible Columns" customizer (figure 8). Name must be always visible.
    • All modules are sorted by Name in ascending order by default. The user can change the ordering by clicking on the table header - a sort indicator will appear then. Other possibilities for sorting are: by Version, Size or by Share status (Share status gives an information about how the modules will be installed. All modules are installed "only for the user" by default, except modules which must be shared). The categories are colored by color used in property sheet (different color for different platforms), row selection uses appropriate color as well.
    • If the user does not want to update certain module, s/he unselects the checkbox in the "Installed" tab and this setting will remain there.
    figure 7a - appearance of "Installed" tab
    figure 7b - appearance of "Available" tab

    figure 7c - appearance of "Local " tab
    • After pressing customizer icon, "Visible columns" customizer appears (figure 8).

    figure 8 - appearance of "Visible Columns" customizer

    • Contextual menu is invokable on the list of modules and contains actions named below (figure 9).
    - selects/deselects module(s) (category) to be installed (for more than one selected module the <module name> is changed to <modules>)
    - selects all modules to be installed
    - deselects all modules to be updated

    - installs selected module to be shared with other users (for more than one selected module the <module name> is changed to <modules>)
    - installs all modules to be shared with other users (for more than one selected module the <module name> is changed to <modules>)
    - installs selected module to not to be shared with other users
    - installs all modules to not to be shared with other users

    - sorts according to the column
    - opens modal dialog (figure 8)
    figure 9 - Contextual menu in NetBeans Update
    • After successful downloading, all modules which were selected to install locally (not shared) are installed at first, then modules, which were selected to install globally, are installed.
      • In case there are other users connected to the server where NetBeans instance is running and the files which must be modified are locked against modifying by the system (Windows), some warning dialog (figure 10) will appear.

    figure 10 - appearance of "Warning" dialog

    Info area contains: Name of the selected module, its certificate (Digitally Signed, Trusted, Not Signed), short module's description (up to three rows + fourth row for "More..." hyperlink) and name of author.

    By clicking on the Install button, Licence agreement dialog is invoked and the user has to accept it to proceed with installation. After accepting the licence, the installation process (modules downloading and their installation (has non-linear progress bar)) is posted to the background (progress indication in the status line).

    If the user stops modules downloading, a warning dialog (progress indication warning dialog) will appear. The user is not allowed to stop installation process.

    Note: It is suggested to have information about module stability (Alpha, Beta, etc.) in "Version" column (e.g. 1.23B - means version:1.23, stability: Beta).

    Update as a background task

    • module installation without restarting IDE - installation is represented as a progress bar in the progress indication area of status line. Status about installation will appear in the info area of status line.
    • module installation with restarting IDE - modal dialog will appear (figure 11)

    figure 11 - "Restart the IDE" modal dialog

    Module groups

    Modules can be divided into two groups:

    1. modules, which does not need restarting the IDE
    2. modules, which needs restarting the IDE

    If modules from both groups are downloaded, the first group of modules is always installed before asking for restarting the IDE, which is necessary for installing the second group of modules.

    Note: If an user is working offline, all tabs except "Local" tab are disabled.

    Note 2:

    1. If there are no new updates on the update center, <All installed modules are up to date. Please try again later.> message should be displayed in the middle of the table.
    2. If there are no new modules on the update center, <No new modules are available. Please try again later.> message should be displayed in the middle of the table.

    3.4. Other dialogs

    figure 12a - Module certificate
    figure 12b - License agreement

    Module Certificate Notes:

    1. If "Always trust modules from this author" checkbox is selected "Not Signed" modules becomes "Trusted" modules.
    2. If "Do Not Trust" button is pressed, the module is excluded from the list of modules.

    License Agreement Notes:

    1. Nowadays an user have to Accept more than one License agreements. We recommend to come up with one general License Agreement (like on NetBeans web site) not to annoy them or to have a Licence Agreement stuck from different Licence Agreements of certain modules.
    2. If "Disagree" button is pressed, NetBeans Updater goes to the "Select modules" screen.

    4. Options - UI design

    Currently the Options dialog is redesigned. In this section, there is proposal what should be under the "Update" node in this dialog (figure 13).

    figure 13 - Options for Update

    5. Position of NetBeans Update in Tools menu

    NetBeans Update (U mnemonic) and Module Manager are placed at the bottom of the Tools menu (figure 14).

    figure 14 - Tools menu

    6. Related links

    For Module Manager UI spec, please click here.

     

    Project Features

    About this Project

    ui was started in November 2009, is owned by Jiří Kovalský, and has 44 members.
    By use of this website, you agree to the NetBeans Policies and Terms of Use (revision 20160708.bf2ac18). © 2014, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo
     
     
    Close
    loading
    Please Confirm
    Close