Specification of an Alias Dialog Component

Wizards, Star Base

Task ID(s)

110234

Category	Specification Affects

Wizards

Abstract

This component describes a commonly used dialog component, that allows the user to assign aliasses or titles to a set of fields.

i-Team

Specification Owner	Berend Cornelius	Berend.Cornelius@sun.com
Marketing Contact		
User Experience Contact	Christian Jansen	Christian.Jansen@Sun.COM
Development Contact	Berend Cornelius	Berend.Cornelius@sun.com
Quality Assurance Contact	Marc Schwanz	Marc.schwanz@sun.com
Documentation Contact	Uwe Fischer	Uwe.Fischer@Sun.COM

Specification Reviews

Version	Reviewer	Comment
Reviewed by UX <Date>	<Name>	<Comment>
UI String Review <Date>		
Reviewed by QA <Date>		
Reviewed by DOC <Date>		

Document History

Version	Author	Comment
Draft <Date>	<Name>	<Comment>
...		
Final <Date>		

Contents

Glossary	1

References	1

1	Motivation	1

2	Goals	1

2.1	How does this feature meet the requirements	1

2.2	How does this feature improve the program architecture	1

3	Dependancies	1

3.1	Technical Dependancies/Requirements	1

4	Detailed Specification	1

4.1	Error Conditions	2

5	Future Tasks	2

6	Legal Issues	2

7	Notes	2

Glossary

Term	Description
<Term 1>	

References

http://java.sun.com/products/jlf/at/book/Wizards.html

Motivation

The reason for this specification is to set up a consistent user interface for the above mentioned task (see Abstract).

Goals

The goal is to design an intuitive and consistent user interface that is able to assign Titles or aliases for a variably big set of fields.

Dependencies

Technical Dependencies / Requirements

There are no direct technical dependancies for this component. It can be implemented by any dialogs because it only makes use of widely used dialog functionality.

Detailed Specification

Illustration 1Measurement of a real life Component

As seen in Illustration 1 scrolling over all fields is achieved by a scrollbar on the right hand side of the dialog.

Scrolling over all the fields is achieved by a scrollbar. When the focus leaves the last textfield next to the scrollbar the scrollbar value should be incremented with the configured block incrementation which is equal to how many lines of controls fit into the component. If there are less fields than available lines of controls in the component the scrollbar is deactivated and the unnecessary textfields are made invisible. On each scroll action the assignments “Name-Title” are updated

The component could for example be initialized with the following parameters:

Dialog Component as specified in com.sun.star.wizards.common.UNODialogs.

Two dimensional string array with fields and titles.

Height of the component. Starting from the height of the component the number of lines that fit in is calculated.

Width of the component.

Array of the Header labels. The first item refers to the name column (“Field” as seen in Illustration 1) the second item to the header of the textfield column (“Aliasname”).

Initial tab index.

The X-Position of the textfields must be assigned in such a way that it does not overwrite any of the fieldnames. If the dialog is an API implementation this could be achieved as follows:

The x Position of the textfields containing the Fieldtitles is calculated after the insertion of the first listbox. It is recommended that at first the label is supplied with a dummystring of several “W”.Via “ API function “getPreferredSize()” it is now possible to calculate the “X” Position of the textfields that will fit to the longest string in the fieldnames' array.

The X Position of the textfields should not be right of half the width of the component, because in the usual practical case titles or aliases will be longer than their corresponding names. The labels should therefor support multliline in case their content might then not fit into the label. The label height should be equal to 16 MA units. If this is still not sufficient ->bad luck, the string will be clipped. But this should be a very rare case as this component is merely designed for names with one or two words. The vertical margin between the textfields is therefor 6 MA.

Used Resources

All strings like the headers for the component (Illustration 1) and the names and initialized titles of the fields are passed over.

String list

Item	English	German	Comments
Button			

Tab Order

The TabOrder begins with the initial TabIndex (“InitTabIndex”) that is passed over. The following tab indices are determined from the position of the respective control in the dialog. The order thus starts from the upper left edge and goes on to the next control on the right hand side and then the next right control in the next control row furhter down.

Controls	Tabindex
First upper left label in the component frame	InitTabIndex
Textfield right of the previous label	InitTabIndex + 1
Label on the left hand side on the next row	InitTabIndex + 2
Textfield right of the previous label	InitTabIndex + 3
...	

Key Board Shortcuts

No Keyboard shortcuts are provided.

Error Conditions

If an error occurs the error is passed over to the calling routine who handles everything for its special case.

Notes

It has to be discussed if the scrollbar needs to have an accessible name.

CJ Issue 1- Is it possible to get rid of the border located to the left of the scrollbar?

BC: I changed it accordingly The only remaining problem that remains with the scrollbar design ist that it cannot be perfectly matched into the corners of the frame. The MAP Units are too rough rasterized.

Specification of an Alias Dialog Component

Page 3

http://dba.openoffice.org/specifications/DialogComponent_AssignAlias.sxw

Berend Cornelius

2003-06-20T10:56:52