Sun Web Application Guidelines - Version 4.1
Search Guidelines    |    Send Feedback   |    Developers.sun.com

How To Use These Guidelines - An Introduction

Release Date: 12/19/07



Table of Contents

Expand All Sections | Collapse All Sections


What's New in 4.1

Click to Expand Chapter0 Revision History

0.1 What's New - Additions and Changes Since Revision 4.0

About the Web Application Guidelines

Click to Expand Chapter1 Introduction

1.1 Icons Used in These Guidelines

1.2 Application Structure

1.3 Resources for Application Developers

1.4 Resources for Application Designers

1.4.1 Approvals

1.4.2 Legal

1.4.3 Branding

1.4.4 Mastheads

1.4.5 Content Page Titles and Other UI Text

1.4.6 Visual Elements and Line Graphs

1.4.7 Accessibility

1.4.8 Globalization

1.5 To Give Feedback

Page Structure and Design

Click to Expand Chapter2 Visual Design Elements


2.1 Color Palette

2.2. Fonts

2.2.1 Font-Family

2.2.2 Font Style and Color

2.2.3 Font Size

2.3 Logos

2.4 Icons

2.4.1 Object Icons

2.4.2 Action Icons

2.4.3 Icons, Glyphs, and Graphics Repository

2.5 Text Capitalization

Click to Expand Chapter3 Windows and Content Pages


3.1 Main Browser Windows

3.2 Pop-Up Windows

3.3 JavaScript Windows

3.4 Pop-up and JavaScript Windows: Advantages and Disadvantages

3.5 Window Title Bars

3.6 Masthead and Top-Level Navigation

3.7 Primary-Content Pages

3.8 Secondary-Content Pages

Click to Expand Chapter4 Mastheads

4.1 Main Window Masthead

4.1.1 Utility Bar

4.1.2 User Name, Current Role, and Management Server

4.1.3 Product Name

4.1.4 Status Area

4.1.5 Java Logo

4.1.6 Sun Company Name in Masthead Footer

4.2 Pop-Up Window Masthead

4.2.1 Product Name

Navigation and Content Presentation

Click to Expand Chapter5 Top-Level Navigation


5.1 Choosing a Navigation Style

5.1.1 Drill Down

5.1.2 Tabbed Panes and Accordion

5.1.2.1 Accordion

5.1.3 Left-Right Pane Set

5.1.4 Tree

5.1.5 Pop-Up Windows for Objects

5.1.6 Combinations of Navigation Styles

5.1.6.1 Drill Down In Left Pane

5.1.6.2 Tree In Left Pane

5.1.6.3 Tree In Tabbed Pane

5.1.6.4 Tree or Flat List In Left Pane of a Tabbed Pane

5.1.6.5 Drill Down In Left Pane of a Tabbed Pane

5.2 Tabbed Panes and Accordion Details

5.2.1 One-Level Tabbed Panes

5.2.2 Two-Level Tabbed Panes

5.2.3 Three-Level Tabbed Panes

5.2.4 Tabs within a Sun.com Web Site Page

5.2.5 Accordion Details

5.3 Left-Right Pane Set Details

5.4 Tree Details

5.4.1 Tree Contents

5.4.1.1 Application Actions Versus Application Objects

5.4.1.2 Types of Container-Nodes

5.4.2 Tree Look and Feel

5.4.2.1 Alarm or Status States of Tree Objects

5.4.2.2 Tree Behavior

5.4.3 Tree Scalability

5.4.3.1 Scaling Methods for Trees

5.5 Common Tasks Page

5.5.1 Access to the Common Tasks Page

5.5.2 Navigational Tasks

5.5.2.1 Navigational Tasks: Flow Diagrams

5.5.3 Action-Based Tasks

5.5.3.1 Action-Based Tasks: Flow Diagrams

5.5.4 Hybrid Tasks

5.5.5 Multiple Session Tasks

Click to Expand Chapter6 Content Area Structure and Layout


6.1 Layout and Alignment of the Content Area

6.1.1 Location of Inline Alert Messages

6.1.2 Using an Asterisk as a Footnote

6.1.3 Marking Required Fields

6.2 Content Page Titles

6.2.1 Primary-Content Page Titles

6.2.2 Secondary-Content Page Titles

6.2.3 General Guidelines for Composing Content Page Titles

6.2.4 Content Page Titles in Relation to Table Titles

6.3 Breadcrumbs and Parentage Paths

6.4 Content Area Navigation

6.4.1 Using a Drop-Down Menu for Content Area Navigation

6.4.1.1 Layout, Style, and Usage Guidelines for Content Area Navigation Drop-Down Menus

6.4.1.2 Usability Tradeoffs of Drop-Down Menus Used for Content Area Navigation

6.4.2 Using Tabs for Content Area Navigation

6.4.2.1 Layout and Style Guidelines for Content Area Navigation Tabs

6.4.2.2 Usage Guidelines for Content Area Navigation Tabs

6.4.2.3 Usability Tradeoffs of Tabs Used for Content Area Navigation

6.4.3 Content Area Navigation Issues Under Investigation

6.5 Content Area Actions

6.5.1 General Guidelines for Content Page Actions

6.5.2 Content Page Action Buttons

6.5.3 Content Page Actions Drop-Down Menu

6.5.4 Using a Combination of Methods for Content Page Actions

6.6 Primary-Content Page Layout and Use

6.6.1 Saving Changes on Primary-Content Pages

6.7 Secondary-Content Page Layout and Use

6.7.1 Saving Changes on Secondary-Content Pages

6.7.2 Using Content Page Sections

6.7.2.1 Jumping To and From Page Sections

6.7.3 Using Tabs on Secondary-Content Pages

6.7.4 Handling Large Amounts of Data

6.8 Noneditable User Interface Elements and Content Pages

6.8.1 Noneditable User Interface Elements

6.8.1.1 User Interface Elements That Invoke Secondary-Content Pages

6.8.2 Noneditable Content Pages

6.8.2.1 Buttons for Noneditable Content Pages

6.8.2.2 Layout Alternatives for Noneditable Content Pages

6.9 Property Page Example

6.10 Drag and Drop within Content Areas

6.10.1 Terminology

6.10.2 Moving Portlets

6.10.3 Creating Portlets

6.10.4 Moving List Items

6.10.5 Selecting Items

6.10.6 Copying Items

6.10.7 Moving Tree Items

6.10.8 Moving Table Rows

6.10.9 Applying Table Rows

User Interface Elements

Click to Expand Chapter7 Simple Elements


7.1 Action Buttons

7.1.1 Primary Buttons

7.1.2 Disabled Buttons

7.1.3 Default Buttons

7.1.4 Iconic Buttons

7.1.5 Button Coding

7.1.6 Button Labels

7.2 Elements Used for Choosing Data, Performing Actions, and Navigating

7.2.1 Elements Used for Choosing One Value

7.2.1.1 Checkbox

7.2.1.2 Set of Radio Buttons

7.2.1.3 Standard Drop-Down Menu

7.2.1.3.1 General Drop-Down Menu Behavior

7.2.1.4 Scrolling List

7.2.2 Elements Used for Choosing One or More Values

7.2.2.1 Set of Checkboxes

7.2.2.2 Multiple Selection Scrolling List

7.2.3 Elements Used for Performing Actions and Navigating

7.2.3.1 Jump Menus

7.2.3.2 Jump Menu Behavior

7.2.3.3 Grouping Menu Items

7.2.3.4 Pop-Up Menu

7.3 Text Elements

7.3.1 Labels

7.3.2 Editable Text Fields

7.3.3 Password Fields

7.3.4 Text Areas

Click to Expand Chapter8 Complex Elements


8.1 Editable Scrolling List

8.2 Add-and-Remove Idiom

8.3 Orderable List

8.4 Date Selection

8.4.1 Pop-Up Calendar

8.4.2 Scheduler Element

8.5 File Selection

8.5.1 Client-Side File Upload

8.5.2 File Chooser Element

8.6 Line Graph

8.6.1 Color Palette

8.6.1.1 Threshold Line Colors

8.6.1.2 Comparative Attribute Line Colors

8.6.2 Lines and Data Points

8.6.3 Text

8.6.3.1 Tick Mark Label Text

8.6.3.2 Axis Text

8.6.3.3 Graph Title: Default

8.6.3.4 Graph Title Text: Property Page

8.6.3.5 Legend Text

8.6.3.6 Other Graph Types and Tips

8.7 Portal Elements

8.7.1 Portlet Definition

8.7.1.1 Title Bar Controls

8.7.1.2 Content Area

8.7.1.3 Page Layout

8.7.2 Portlet Table

8.7.3 Portlet Mini Tab Group

Click to Expand Chapter9 Tables


9.1 General Table Guidelines

9.1.1 Basic Table Anatomy

9.1.2 Table Characteristics

9.1.3 Displaying Empty Tables

9.1.4 Displaying Empty Table Cells

9.1.5 Property Table

9.1.6 Table Interactive Example

9.2 Embedded Table Navigation

9.3 Selection in Tables

9.3.1 Single Selection in Tables

9.3.2 Multiple Selection in Tables

9.4 Table Actions

9.4.1 Definition of Table Actions and Related Terms

9.4.2 General Guidelines for Table Actions

9.4.3 Design Options for Table Actions

9.4.3.1 Using Only Buttons for Table Actions

9.4.3.2 Using a Single Drop-Down Menu for Table Actions

9.4.3.3 Using Embedded Table Actions

9.4.3.4 Using a Combination of Methods for Table Actions

9.4.4 Dynamic Enabling and Disabling of Table Actions

9.4.5 Maintaining Non-Displayed Selections

9.5 Changing Table Views

9.5.1 Table Filtering

9.5.1.1 Basic Table Filtering

9.5.1.2 Custom Table Filtering

9.5.2 Table Sorting

9.5.2.1 Direct Table Sorting

9.5.2.2 Multiple-Column Sort Panel

9.5.2.3 Natural Sort Order and Clearing Sorts

9.5.3 Table Preferences

9.5.4 Vertical Pagination in Tables

9.5.4.1 Vertical Pagination User Interface Elements

9.5.5 Horizontal Scrolling in Tables

9.5.6 View-Changing Buttons

9.5.7 Grouped Tables

9.5.7.1 Grouped Table Limitations and Future Plans

9.6 AJAX Table (Next Generation Table)

9.6.1 AJAX Table Overview

9.6.2 General Anatomy

9.6.3 Basic Interactions

9.6.3.1 Object Selection

9.6.3.2 Selection Column Header

9.6.3.3 Performing an Action on an Item

9.6.3.4 Moving by Keyboard

9.6.3.5 Resizing of Columns

9.6.3.6 Sorting of Columns

9.6.3.7 Inline Editing

9.6.4 Lazy Data Download and Progress Indication

9.6.5 Table Controls Drawer

9.6.6 Filter

9.6.7 Custom Filter

9.6.7.1 Custom Filter Interaction

9.6.7.2 Defining a Criterion

9.6.8 Data Export

9.6.9 Column Selection

9.6.10 Multiple Sort

9.6.11 Spanning Headers

9.6.12 Table Tips

9.6.13 Grouped Tables

Click to Expand Chapter10 Topology

10.1 Introduction

10.1.1 A Working Definition

10.1.2 Their Role in System Management Applications

10.2 Challenges in Designing Topologies

10.2.1 Handling Scale Gracefully

10.2.2 Managing Complexity

10.2.3 Achieving a Sun-Wide Common Look-and-Feel

10.2.4 Dealing with the Limitations of Web Browsers

10.2.5 Facilitating Positive Transfer across Different Representation Types

10.2.6 Integrating Into System Management Applications

10.2.7 Supporting Accessibility for Users with Disabilities

10.3 Choosing a Topology Representation

10.3.1 Attributes of Topologies

10.3.1.1 Primary Attributes (Number of Tiers and Number of Objects per Tier)

10.3.1.2 Secondary Attributes (Connectivity and Multipathed Topologies)

10.3.2 Guidelines for Choosing a Topology Representation

10.3.2.1 Guidelines for One-Tier Topologies

10.3.2.2 Guidelines for Two-Tier Topologies

10.3.2.3 Guidelines for Topologies With Three or More Tiers

10.3.2.4 Guidelines for Representing Within-Tier Connections

10.4 View Elements

10.4.1 Showing Topology Objects

10.4.2 Showing Topology Connections

10.4.3 Showing Alarm States

10.4.4 Showing Directed Relationships

10.4.5 Showing Filtered Views

10.4.6 Showing Aggregate Objects

10.4.7 Showing Aggregate Connections

10.4.8 Showing a Timestamp

10.4.9 Showing an Icon Legend

10.4.10 Showing Sub-Components

10.5 Layout Guidelines for Topologies

10.5.1 General Layout Guidelines

10.5.2 Layout Guidelines for Small-Scale Topologies

10.5.3 Layout Guidelines for Moderate-Scale Topologies

10.5.4 Display Guidelines for Large-Scale Topologies

10.6 Interaction Elements

10.6.1 Mouse-Over Feedback and Tool Tips

10.6.2 Object Selection Behavior

10.6.3 Contextual Menus

10.6.4 Clickable Regions

10.6.4.1 Managed Objects

10.6.4.2 Connections

10.6.5 Expanding and Collapsing Aggregates

10.6.6 Saving Topologies

10.7 Methods for Integration with Primary Navigation

10.7.1 Showing Connectivity for a Selected Object

10.7.2 Showing Paths from a Selected Object

10.8 Issues for Future Investigation

User Assistance

Click to Expand Chapter11 Contextual Help


11.1 Inline Help

11.1.1 Deciding Whether to Provide Inline Help

11.1.2 Positioning Inline Help

11.1.3 Formatting Inline Help

11.1.4 Including Links in Inline Help

11.1.5 Writing Inline Help

11.2 Help-Window Help

11.2.1 Layout and Behavior of the Help Window

11.2.1.1 Anatomy of the Help Window

11.2.1.2 Sizing of the Help Window

11.2.1.3 Window Title Bar in the Help Window

11.2.1.4 Content-Area Title Pane in the Help Window

11.2.1.5 Navigation Pane in the Help Window

11.2.1.6 Topic Pane in the Help Window

11.2.2 Providing Access to Help-Window Help

11.3 Left-Pane Help

11.4 Choosing the Correct Type of Help

11.4.1 Providing Help for Main Windows

11.4.2 Providing Help for Pop-up Windows

11.5 Tool Tips

11.5.1 Creating Tool Tips

11.5.2 Creating Longer Descriptions Using the HTML longdesc Attribute

11.5.3 Tool Tips for Sun Icons, Glyphs, and Graphics

11.5.4 A Note on HTML alt and longdesc Attributes for Tree Navigation Objects

11.5.5 Visual Design Considerations for Tool Tips

11.5.6 Tool Tips for Disabled Icons

11.5.7 Tool Tips for Icons with Alarm Badges

11.5.8 Tool Tip Resources

11.6 Pop-Up Bubble

11.6.1 Invoking and Closing Pop-Up Bubbles

11.6.2 Pop-Up Bubble Content Details

Click to Expand Chapter12 Search

12.1 Quick Search

12.1.1 Global Quick Search

12.1.1.1 Global Quick Search: Predefined Queries

12.1.1.2 Global Quick Search: Application-Wide Text Search

12.1.1.3 Global Quick Search: Scoped Text Search

12.1.2 Local Quick Search

12.1.2.1 Local Quick Search: Predefined Queries

12.1.2.2 Local Quick Search: Local Text Search

12.1.2.3 Local Quick Search: Scoped Text Search

12.2 Advanced Search

12.2.1 Global Advanced Search

12.2.1.1 Global Advanced Search in Main Windows

12.2.1.2 Global Advanced Search in Pop-Up Windows

12.2.2 Adding Scoping to Advanced Search

12.2.3 Contextual Advanced Search

12.3 Search Results

12.3.1 Global Quick Search Results

12.3.1.1 Global Quick Search Results in Main Windows

12.3.1.2 Global Quick Search Results in Pop-Up Windows

12.3.2 Local Quick Search Results

12.3.2.1 Local Quick Search Results in Main Windows

12.3.2.2 Local Quick Search Results in Pop-Up Windows

12.3.3 Advanced Search Results

12.3.3.1 Advanced Search Results in Main Windows

12.3.3.2 Advanced Search Results in Pop-Up Windows

Click to Expand Chapter13 Wizards


13.1 Anatomy

13.1.1 Steps List Anatomy

13.1.1.1 Branching Represented as Substeps

13.1.1.2 Branching Represented as Placeholder

13.1.2 Help in the Left Pane

13.1.3 Overview Page

13.1.4 Review Selections Page

13.1.5 View Results Page

13.2 Behavior

13.2.1 Basics

13.2.2 Backtracking

13.2.3 Finish Button and Results Page


Feedback, Login, and Version Information

Click to Expand Chapter14 Alerts and Messages


14.1 Inline Alerts

14.1.1 Example of Information Inline Alert

14.1.2 Example of Error Inline Alert

14.1.3 Example of Warning Inline Alert

14.1.4 Example of Success Inline Alert

14.2 JavaScript Alerts

14.3 Full-Page Alerts

14.4 Alerts Shown in a Pop-Up Window

14.5 Validation Error Alerts

14.5.1 Validation Error Messages

14.6 Choosing the Correct Alert Display Type

Click to Expand Chapter15 Progress Indicators


15.1 Progress Indicator Types

15.1.1 Determinate Progress Bar

15.1.2 Indeterminate Progress Bar

15.1.3 Busy Indicator

15.2 Progress Indicator Elements

15.2.1 Button Controls

15.3 Progress Indicators in Context

15.3.1 Busy Indicator - Inline

15.3.2 Progress Bar in a Pop-Up Window

15.3.3 Progress Bar in a Wizard

15.3.4 Progress Bars in a Table

15.4 Jobs Overview Page

15.5 Jobs Running Display in a Main Window Masthead

Click to Expand Chapter16 Alarms and Status Indicators


16.1 Alarms

16.1.1 Alarm Creation

16.1.2 Alarm Severity

16.1.3 Alarm Status

16.1.4 Logging Events

16.1.5 Alarm Views

16.1.5.1 Alarms in Trees

16.1.5.2 Alarms in Topology Views

16.1.5.3 Alarms in Tables

16.1.5.3.1 Alarm Summary View

16.1.5.3.2 Alarm Rollup View

16.1.5.3.3 Alarm Details View

16.1.5.4 Alarms in the Masthead

16.1.6 Alarm Graphics

16.1.7 Inactive Alarm Expiration

16.2 Status

16.2.1 Status Indicators

16.2.1.1 Object Status

16.2.1.1.1 Object Status Icons and Values

16.2.1.2 Detailed Status

16.2.2 Displaying Status

16.2.2.1 Status in a Table View

16.2.2.1.1 Object Status in Tables

16.2.2.1.2 Detailed Status in Tables

16.2.2.2 Status in a Topology View

16.2.2.3 Status in a Tree View

16.2.2.4 Object Status Summary

Click to Expand Chapter17 Login Page


17.1 Login Page Elements

17.1.1 Utility Bar

17.1.2 Branding Image with Sun and Java Logos

17.1.3 Branding Image Border

17.1.4 Product Name Image

17.1.5 Copyright Information for the Sun Java(TM) Web Console

17.1.6 Page Background

17.2 Login Page Form Area

17.2.1 Type-Specific Form Fields

17.3 Additional Login Pages

17.4 Inline Alerts for Login Pages

Click to Expand Chapter18 Version Page


18.1 Version Page Elements

18.1.1 Branding Image with Sun Logo

18.1.2 Product Name Image

18.1.3 Java Logo

18.1.4 Application Version Number

18.1.5 Legal Notice


Additional Information

Click to Expand ChapterAppendices

Appendix A - Component Library Information

Appendix B - Examples and Specifications

Appendix C - Product Name Images

Appendix D - Accessibility Requirements

Appendix E - Pixel Specifications

Appendix F - Alert Graphics (sized)

Appendix G - Badging Icons

Appendix H - Globalization Requirements

 

Privacy Policy  |  Terms of Use  |  Trademarks  |  Copyright 2007 Sun Microsystems, Inc.