このページはEtoJ逐語翻訳フィルタによって翻訳生成されました。

翻訳前ページへ


Interface XWizard
Language

The 解放する/自由な and Open 生産性 控訴
解放(する)d: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: 星/主役にする :: ui :: dialogs ::

interface XWizard
Base Interfaces
XWizardXExecutableDialog

XExecutableDialog
(言及/関連d interface's 要約:)
明示するs an interface for an executable dialog.
Description
is the main interface 器具/実施するd by the Wizard services.

A wizard is a dialog which guides the 使用者 through a number of 仕事s (usually input of data), which the 使用者 can 遂行する either sequentially or out-of-order. For this, a wizard is 構成するd of a number of tab pages, each page 代表するing a 選び出す/独身 step.

Sequential 航海 in a wizard is done 経由で a Next and a 支援する button. 非,不,無-sequential 航海 is done 経由で a roadmap, which is 陳列する,発揮するd on the left 手渡す 味方する of the wizard dialog, 名簿(に載せる)/表(にあげる)s all 利用できる steps, and 許すs jumping to a 確かな step (where the creator of the wizard can 制限する the 利用できる steps depending on the 現在の 状況/情勢 in the wizard, see below).

A sequence of steps in a wizard dialog is called a path. A given wizard can support one or 多重の paths, which are 宣言するd at the time of construction of the wizard.

In the simplest 事例/患者, where the wizard supports only one path, all 利用できる steps are 陳列する,発揮するd in the roadmap, and the 使用者 can 簡単に travel through them as 願望(する)d.

If the wizard is more コンビナート/複合体, and supports 多重の paths, things become more 複雑にするd. In a given 状況/情勢 of the wizard, where the 使用者 is at step k of the 現在の path, the 可能性のある or 相反する paths are those whose first k steps are the same as in the 現在の path. 明白に, there's at least one 可能性のある path in every 状況/情勢: the 現在の one. If there is more than one, then the 未来 steps in the dialog are not finally decided. In such a 事例/患者, the roadmap will 陳列する,発揮する 未来 steps up to the point where the 可能性のある paths diverge, and then an item ... 示すing that the order of steps is 決めかねて.

An XWizardController can 宣言する a 確かな path as active path by calling the activatePath method. Usually, this is done depending on 使用者 input. For instance, your wizard could have 無線で通信する buttons on the first page which 効果的に decide about which path to take in the wizard.

選び出す/独身 steps in the wizard can be 自由に enabled and 無能にするd, using the enablePage method. 無能にするd pages are skipped during sequential traveling, and not selectable in the roadmap.

The 明言する/公表する of the Next button in the dialog will be automatically 持続するd in most 状況/情勢s, depending on the results of calls to the XWizardController::canAdvance and XWizardPage::canAdvance methods. More sophisticated wizard logic, however, will need 手動式の calls to the enableButton method. Also, the Finish button needs to be 持続するd by the wizard's 監査役, too, as it cannot be decided generically in which 状況/情勢s it should be enabled or 無能にするd.

See also
XWizardController, XWizardPage

Methods' 要約
getCurrentPage 供給するs 接近 to the 現在の page of the wizard  
enableButton enables or 無能にするs a 確かな button in the wizard  
setDefaultButton 始める,決めるs a button in the wizard as default button  
travelNext travels to the next page, if possible  
travelPrevious travels to the next page, if possible  
enablePage enables or 無能にするs the given page  
updateTravelUI updates the wizard elements which are 関係のある to traveling.  
advanceTo 前進するs to the given page, if possible.  
goBackTo goes 支援する to the given page, if possible.  
activatePath 活動させる/戦時編成するs a path  
せいにするs' 要約
HelpURL is the help URL of the wizard's main window.  
DialogWindow  
Methods' 詳細(に述べる)s
getCurrentPage
XWizardPage
getCurrentPage();

Description
供給するs 接近 to the 現在の page of the wizard
enableButton
無効の
enableButton( [in] short  WizardButton,
[in] boolean  Enable );

Description
enables or 無能にするs a 確かな button in the wizard

普通は, you will want to use this method for the Finish button only: The Next and 支援する buttons are usually 持続するd automatically, the Help and 取り消す buttons are ありそうもない to ever 存在 無能にするd.

Parameter WizardButton
denotes the button to enable or 無能にする, as one of the WizardButton constants. Must not be WizardButton::NONE.
Parameter Enable
明示するs whether the button should be enabled (true) or 無能にするd (誤った)
setDefaultButton
無効の
setDefaultButton( [in] short  WizardButton );

Description
始める,決めるs a button in the wizard as default button

In general, the default button in a wizard is the one which is 活動させる/戦時編成するd when the 使用者 圧力(をかける)s the return 重要な while the 焦点(を合わせる) is in a 支配(する)/統制する which does not 扱う this 重要な itself (such as ordinary input 支配(する)/統制するs).

You can use this method, for instance, to make the Next button the default button on all pages except the last one, where Finish should be defaulted.

travelNext
boolean
travelNext();

Description
travels to the next page, if possible

Calling this method is 同等(の) to the 使用者 圧力(をかける)ing the Next button in the wizard. その結果, the method will fail if in the 現在の 明言する/公表する of the wizard, it is not 許すd to 前進する to a next page.

travelPrevious
boolean
travelPrevious();

Description
travels to the next page, if possible

Calling this method is 同等(の) to the 使用者 圧力(をかける)ing the 支援する button in the wizard.

enablePage
無効の
enablePage( [in] short  PageID,
[in] boolean  Enable )
raises( ::com::sun::星/主役にする::コンテナ::NoSuchElementException,
::com::sun::星/主役にする::util::InvalidStateException );

Description
enables or 無能にするs the given page

You can use this method when not all pages of your wizard are やむを得ず needed in all 事例/患者s. For instance, assume that your first wizard page 含む/封じ込めるs a check box, which the 使用者 can check to enter 付加 data. If you place this data on the second page, then you will want to enable this second page if and only if the checkbox is checked.

If a page is 無能にするd, it can reached neither by clicking the 各々の item in the wizard's roadmap, nor by sequential traveling. Still, the page's item is 陳列する,発揮するd in the roadmap, though 無能にするd.

Throws
::com::sun::星/主役にする::コンテナ::NoSuchElementException if there is no page with the given ID
Throws
::com::sun::星/主役にする::util::InvalidStateException if the page shall be 無能にするd, but is active 現在/一般に.
updateTravelUI
無効の
updateTravelUI();

Description
updates the wizard elements which are 関係のある to traveling.

For instance, the Next button is 無能にするd if the 現在の page's XWizardPage::canAdvance method returns 誤った.

You usually call this method from within a wizard page whose 明言する/公表する changed in a way that it 影響する/感情s the 使用者's ability to reach other pages.

advanceTo
boolean
advanceTo( [in] short  PageId );

Description
前進するs to the given page, if possible.

Calling this method is 同等(の) to the 使用者 繰り返して 圧力(をかける)ing the Next button, until the given page is reached. その結果, the method will fail if one of the 中間の pages does not 許す 前進するing to the next page.

goBackTo
boolean
goBackTo( [in] short  PageId );

Description
goes 支援する to the given page, if possible.

Calling this method is 同等(の) to the 使用者 繰り返して 圧力(をかける)ing the 支援する button, until the given page is reached.

activatePath
無効の
activatePath( [in] short  PathIndex,
[in] boolean  Final )
raises( ::com::sun::星/主役にする::コンテナ::NoSuchElementException,
::com::sun::星/主役にする::util::InvalidStateException );

Description
活動させる/戦時編成するs a path

If the wizard has been created with 多重の paths of 支配(する)/統制する flow, then this method 許すs switching to another path.

You can only 活動させる/戦時編成する a path which 株 the first k pages with the path which is 以前 active (if any), where k is the 索引 of the 現在の page within the 現在の path.

Example: Say you have paths, (0,1,2,5) and (0,1,4,5) (with the numbers denoting page IDs). This means that after page 1, you either continue with page 2 or 明言する/公表する 4,and after this, you finish in 明言する/公表する 5.
Now if the first path is active, and your 現在の 明言する/公表する is 1, then you can easily switch to the second path, since both paths start with (0,1).
However, if your 現在の 明言する/公表する is 2, then you can not switch to the second path anymore.

Parameter PathIndex
the 索引 of the path, as used in the Wizard::createMultiplePathsWizard 建設者.
Parameter Final

If true, the path will be 完全に 活動させる/戦時編成するd, even if it is a 相反する path (i.e. there is another path which 株 the first k 明言する/公表するs with the to-be-活動させる/戦時編成するd path.)

If 誤った, then the new path is checked for 衝突s with other paths. If such 衝突s 存在するs, the path is not 完全に 活動させる/戦時編成するd, but only up to the point where it does not 衝突.

In this latter 事例/患者, you need another activatePath method (usually 誘発する/引き起こすd by the 使用者 doing some 決定/判定勝ち(する)s and entering some data on the reachable pages) before the wizard can 現実に be finished.

With the paths in the example above, if you 活動させる/戦時編成する the second path, then only steps 0 and 1 are 活動させる/戦時編成するd, since they are ありふれた to both paths. Steps 2, 4, and 5 are not reachable, yet.

Throws
::com::sun::星/主役にする::コンテナ::NoSuchElementException if there is no path with the given 索引
Throws
::com::sun::星/主役にする::util::InvalidStateException if the path cannot be 活動させる/戦時編成するd in the 現在の 明言する/公表する of the wizard.
せいにするs' 詳細(に述べる)s
HelpURL
string HelpURL;
Description
is the help URL of the wizard's main window.
DialogWindow
[ readonly ] ::com::sun::星/主役にする::awt::XWindow DialogWindow;
最高の,を越す of Page

Apache Software Foundation

Copyright & License | Privacy | 接触する Us | 寄付する | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are 登録(する)d trademarks of The Apache ソフトウェア 創立/基礎. The Apache feather logo is a trademark of The Apache ソフトウェア 創立/基礎. Other 指名するs appearing on the 場所/位置 may be trademarks of their 各々の owners.