Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » ui » dialogs

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: ui :: dialogs ::

interface XWizardPage

Base Interfaces XWizardPage ┗ ::com::sun::star::lang::XComponent ::com::sun::star::lang::XComponent (referenced interface's summary:) allows to exclicitly free resources and break cyclic references.

Description is a single page of a Wizard

---

Methods' Summary
activatePage	called when the page is activated
commitPage	is called when the page is about to be left
canAdvance	determines whether it is allowed to travel to a later page in the wizard

Attributes' Summary
Window	provides read-only access to the window of the page
PageId	denotes the ID of the page.

Methods' Details

activatePage void activatePage(); Description called when the page is activated

commitPage boolean commitPage( [in] short  Reason ); Description is called when the page is about to be left An implementation can veto the leave by returning false here. Usually, the decision about this depends on the current state of the page. Parameter Reason is one of the WizardTravelType contants denoting the reason why the page should be committed.

canAdvance boolean canAdvance(); Description determines whether it is allowed to travel to a later page in the wizard You should base this decision on the state of the page only, not on a global state of the wizard. Usually, you return false here if and only if not all necessary input on the page has been provided by the user, or the provided input is not valid. If checked for validity is expensive, or if you prefer giving your user more detailed feedback on validity than a disabled Next button in the wizard, then move your checks to the commitPage method.

Attributes' Details

Window [ readonly ] ::com::sun::star::awt::XWindow Window; Description provides read-only access to the window of the page

PageId [ readonly ] short PageId; Description denotes the ID of the page. Within a wizard, no two pages are allowed to have the same ID.

Top of Page

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.