Transition Windows - Revision history

Paulb at 18:11, 14 May 2008

2008-05-14T18:11:10Z

Paulb at 18:09, 14 May 2008

2008-05-14T18:09:54Z

Paulb: /* Using Transition Windows */

2008-05-14T18:05:21Z

‎Using Transition Windows

Paulb at 17:49, 14 May 2008

2008-05-14T17:49:56Z

Paulb: Main Page/Transition Windows moved to Transition Windows: Wrong title.

2008-05-14T17:42:46Z

Main Page/Transition Windows moved to Transition Windows: Wrong title.

Paulb at 17:27, 14 May 2008

2008-05-14T17:27:22Z

Paulb at 17:16, 14 May 2008

2008-05-14T17:16:52Z

Paulb at 16:15, 14 May 2008

2008-05-14T16:15:57Z

New page

{{UnderConstruction}}
[[Category:Extending EiffelStudio]]
[[Category:EiffelStudio Foundations]]

Transition windows were added to [EiffelStudio] in version [6.2] and are used to inform the user some action is being performed that may take a few seconds or more. They are visual cues to the user, beyond a simple wait cursor, preventing any other UI interaction whilst some foreground task is being processed.

A few examples of the use of transition windows are:
* Switching between edit/debug profiles.
* Submitting exceptions reports, while the report is being posted.
* Rescanning the code template catalog for changes.

Transition windows however are not to be used in place of a wait cursor. They are for prolonged tasks processed at the users request. Too many transition windows will hinder and annoy rather than simply assist in informing the user. For example, it would see like loading a project calls for a transition window because it can take a few seconds for large projects. However, showing a transition window as the project is loaded seems like it is adding a peripheral step to the opening project process. The are also visual cues that the project is loading from within the IDE and so a transition window here would not be recommended.

Transition windows are shown prior to running a task and are shutdown on the completion of a task.

← Older revision		Revision as of 18:11, 14 May 2008
Line 1:		Line 1:
−	~~{{UnderConstruction}}~~
	[[Category:Extending EiffelStudio]]		[[Category:Extending EiffelStudio]]
	[[Category:EiffelStudio Foundations]]		[[Category:EiffelStudio Foundations]]

@@ Line 24: / Line 24: @@
 == Using Transition Windows ==
-There are two usage models for showing and performing actions whilst a transition window is shown. First there is a simplistic approach, letting the transition window do all the work for you, just by setting an action on the window. This approach frees any client from having to retain a reference to a transition window to close it when the action is performed, as
+There are two usage models for showing and performing actions whilst a transition window is shown. First there is a simplistic approach, letting the transition window do all the work for you, just by setting an action on the window. This approach frees any client from having to retain a reference to a transition window to close it when the action is performed, if necessary.
 <e>
@@ Line 30: / Line 30: @@
        -- Submits a report.
      local
        l_transition: !ES_POPUP_TRANSITION_WINDOW
      do
@@ Line 50: / Line 49: @@
 </e>
-Once the action has been performed the transition window will be automatically closed. Because transition windows are based on [[EiffelStudio Foundations|ESF]] dialog, they are recycled on closing so no explicit call to <e>recycle</e> is needed.
+Once the action has been performed the transition window will be automatically closed, so there is no need to explictly call <e>hide</e>
 The other approach is to call the action, to be processed when the transition window is shown, explicitly and call <e>hide</e> on the window after the action has been processed.
@@ Line 69: / Line 68: @@
      end
 </e>

← Older revision		Revision as of 17:49, 14 May 2008
Line 13:		Line 13:

	Transition windows are shown prior to running a task and are shutdown on the completion of a task.		Transition windows are shown prior to running a task and are shutdown on the completion of a task.
		+
		+	== The Anatomy of a Transition Window ==
		+
		+	A transition window is composed of three parts; a window, a message and an optional icon. The image below shows the window constituents, each part fully accessible from the <e>ES_POPUP_TRANSITION_WINDOW</e> interface.
		+
		+	[[image:Transition window.png]]
		+
		+	Transition windows are specialized [Popup Windows\|pop-up window] but are not susceptible to demanded focusing as with pop-up windows, hence clicking elsewhere in the background will not force with window to close.

	== Using Transition Windows ==		== Using Transition Windows ==

@@ Line 31: / Line 31: @@
        l_transition.set_action (agent perform_submit)
        l_transition.show_relative_to_window (dialog)
      end
@@ Line 46: / Line 42: @@
 </e>
-<e>
+Once the action has been performed the transition window will be automatically closed. Because transition windows are based on [[EiffelStudio Foundations|ESF]] dialog, they are recycled on closing so no explicit call to <e>recycle</e> is needed.
 <e>
    on_submit_report
        -- Submits a report.
      local
        l_transition: !ES_POPUP_TRANSITION_WINDOW
      do
@@ Line 61: / Line 59: @@
        perform_submit
        l_transition.hide
      end
 </e>

← Older revision		Revision as of 17:16, 14 May 2008
Line 13:		Line 13:

	Transition windows are shown prior to running a task and are shutdown on the completion of a task.		Transition windows are shown prior to running a task and are shutdown on the completion of a task.
		+
		+	== Using Transition Windows ==
		+
		+	There are two usage models for showing and performing actions whilst a transition window is shown. First there is a simplistic approach, letting the transition window do all the work for you, just by setting an action on the window. This approach frees any client from having to retain a reference to a transition window to close it when the action is performed, as
		+
		+	<e>
		+	on_submit_report
		+	-- Submits a report.
		+	local
		+	l_thanks: !ES_INFORMATION_PROMPT
		+	l_transition: !ES_POPUP_TRANSITION_WINDOW
		+	do
		+	create l_transition.make_with_icon (
		+	("Submitting report, please wait...").as_string_32,
		+	submit_icon)
		+
		+	l_transition.set_action (agent perform_submit)
		+	l_transition.show_relative_to_window (dialog)
		+
		+	create l_thanks.make_standard ("Thank you for submitting the report.")
		+	l_thanks.set_sub_title ("Thank You!")
		+	l_thanks.show (dialog)
		+	end
		+
		+	...
		+
		+	perform_submit
		+	-- Performs actual submission.
		+	do
		+	...
		+	end
		+	</e>
		+
		+	<e>
		+	<e>
		+	on_submit_report
		+	-- Submits a report.
		+	local
		+	l_thanks: !ES_INFORMATION_PROMPT
		+	l_transition: !ES_POPUP_TRANSITION_WINDOW
		+	do
		+	create l_transition.make_with_icon (
		+	("Submitting report, please wait...").as_string_32,
		+	submit_icon)
		+
		+	l_transition.show_relative_to_window (dialog)
		+	perform_submit
		+	l_transition.hide
		+
		+	create l_thanks.make_standard ("Thank you for submitting the report.")
		+	l_thanks.set_sub_title ("Thank You!")
		+	l_thanks.show (dialog)
		+	end
		+	</e>

@@ Line 3: / Line 3: @@
 [[Category:EiffelStudio Foundations]]
-Transition windows were added to [EiffelStudio] in version [6.2] and are used to inform the user some action is being performed that may take a few seconds or more. They are visual cues to the user, beyond a simple wait cursor, preventing any other UI interaction whilst some foreground task is being processed.
+Transition windows were added to [[EiffelStudio]] in version [[EiffelStudio 6.2 Releases|6.2]] and are used to inform the user some action is being performed that may take a few seconds or more. They are visual cues to the user, beyond a simple wait cursor, preventing any other UI interaction whilst some foreground task is being processed.
 A few examples of the use of transition windows are:
@@ Line 9: / Line 9: @@
 * Submitting exceptions reports, while the report is being posted.
 * Rescanning the code template catalog for changes.
 Transition windows are shown prior to running a task and are shutdown on the completion of a task.
@@ Line 73: / Line 71: @@
 === Recommendations ===
 Transition windows require a message but an icon is optional. However, it is recommended that ''every'' transition window have an icon.

← Older revision	Revision as of 17:42, 14 May 2008
(No difference)