Interface XUndoManager

Devguide

索引

Methods' 要約

せいにするs' 要約

Methods' 詳細（に述べる）s

せいにするs' 詳細（に述べる）s

:: com :: sun :: 星／主役にする :: 文書 ::

interface XUndoManager

Base Interfaces

XUndoManager
┣ ::com::sun::星／主役にする::util::XLockable
┗ ::com::sun::星／主役にする::コンテナ::XChild

::com::sun::星／主役にする::util::XLockable	Description 許すs locking the undo 経営者／支配人.
::com::sun::星／主役にする::コンテナ::XChild	Description 許すs 接近ing the 構成要素, usually a 文書, which the undo 経営者／支配人作品 for. ::com::sun::星／主役にする::コンテナ::XChild::setParent is not supported, and will throw an ::com::sun::星／主役にする::lang::NoSupportException.

Description

供給するs 接近 to the undo/redo stacks of a 文書

Undo

Changes to a 文書 usually result in 記録，記録的な／記録するing of （警察などへの）密告，告訴（状） how to undo those changes, if 願望（する）d. A いわゆる undo 活動／戦闘記録，記録的な／記録するs the （警察などへの）密告，告訴（状） how to undo a 選び出す／独身 change. Undo 活動／戦闘s are 持続するd in a stack, so that the changes they 代表する can be undo in the 逆転する order they have 初めは been 適用するd.

Redo

Additionally, the Undo 経営者／支配人 manages a Redo stack: 活動／戦闘s which are undone are moved from the Undo to the Redo stack, so it is possible to re-適用する the changes to the 文書.

Undo 状況s

For collecting 多重の changes in a 選び出す／独身 undo 活動／戦闘, いわゆる Undo 状況s are 供給するd. When an Undo 状況 is entered, all subsequently 追加するd Undo 活動／戦闘s are not 押し進めるd の上に the undo stack 直接／まっすぐに, but considered a sub 活動／戦闘 of the Undo 状況. Once the Undo 状況 is left, a 選び出す／独身 undo 活動／戦闘 is 押し進めるd の上に the undo stack, which 構成するs all those 選び出す／独身 Undo 活動／戦闘s.
Undo 状況s can be arbitrarily nested.

Hidden Undo 活動／戦闘s

Hidden Undo 活動／戦闘s are those which in no observable way 与える／捧げる to the undo stack. That is, any method retrieving （警察などへの）密告，告訴（状） about the stack will behave as if the undo 活動／戦闘 does not 存在する. Nonetheless, calling undo それぞれ redo will 含む those 活動／戦闘s.
Hidden Undo 活動／戦闘s can be created by calling enterHiddenUndoContext, に引き続いて by leaveUndoContext.

Locking

An Undo 経営者／支配人 can be locked and 打ち明けるd, using the ::XLockable::lock and ::XLockable::打ち明ける methods. When it is locked, then every 試みる／企てる to 追加する an undo 活動／戦闘, or to enter or leave an Undo 状況, will be silently ignored.

Methods' 要約
enterUndoContext	enters a new undo 状況.
enterHiddenUndoContext	enters a new undo 状況, creating a hidden undo 活動／戦闘.
leaveUndoContext	leaves the undo 状況以前 opened 経由で enterUndoContext それぞれ enterHiddenUndoContext.
addUndoAction	追加するs the given undo 活動／戦闘 to the undo stack.
undo	逆戻りするs the most 最近の活動／戦闘 on the 文書.
redo	replays the 活動／戦闘 on the 文書 which has most recently been undone
isUndoPossible	決定するs whether undo can reasonably be 推定する／予想するd to 後継する.
isRedoPossible	決定するs whether redo can reasonably be 推定する／予想するd to 後継する.
getCurrentUndoActionTitle	returns the 肩書を与える of the 最高の，を越す-most 活動／戦闘 on the undo stack
getCurrentRedoActionTitle	returns the 肩書を与える of the 最高の，を越す-most 活動／戦闘 on the Redo stack
getAllUndoActionTitles	returns the 肩書を与えるs of all 活動／戦闘s 現在／一般に on the undo stack, from 最高の，を越す to 底（に届く）
getAllRedoActionTitles	returns the 肩書を与えるs of all 活動／戦闘s 現在／一般に on the Redo stack, from 最高の，を越す to 底（に届く）
（疑いを）晴らす	（疑いを）晴らすs the undo and the redo stack.
clearRedo	（疑いを）晴らすs the redo stack.
reset	resets the Undo 経営者／支配人
addUndoManagerListener	追加するs a listener to be 通知するd of changes in the Undo/Redo stacks.
removeUndoManagerListener	除去するs a 以前追加するd listener

Methods' 詳細（に述べる）s

enterUndoContext

無効の
enterUndoContext(	[in] string	i_title );

Description

enters a new undo 状況.

A new undo 活動／戦闘 will be 追加するd to the undo stack, with the 肩書を与える given as i_title. As long as the 状況 is not left, every undo 活動／戦闘追加するd to the stack will be 扱う／治療するd as sub 活動／戦闘. This means it will not be 直接／まっすぐに accessible at the Undo 経営者／支配人, not appear in any 使用者 interface, and cannot be 分かれて undone or re-done.

Each call to enterUndoContext must be paired by a call to leaveUndoContext, さもなければ, the 文書's undo stack is left in an inconsistent 明言する／公表する.

Undo 状況s can be nested, i.e. it is 合法的 to call enterUndoContext and enterHiddenUndoContext 多重の times without calling leaveUndoContext inbetween.

See also

leaveUndoContext

enterHiddenUndoContext

無効の
enterHiddenUndoContext()
raises(	EmptyUndoStackException );

Description

enters a new undo 状況, creating a hidden undo 活動／戦闘.

A hidden undo 活動／戦闘 does not, in any 明白な way, 与える／捧げる to the undo stack. This means that

Calling undo when the 最高の，を越す-element is a hidden undo 活動／戦闘 will transparently undo this 活動／戦闘, and also undo the new 最高の，を越す element of the stack.
Calling redo when the 最高の，を越す-element is a hidden 活動／戦闘 will transparently redo this 活動／戦闘, and also redo the new 最高の，を越す element of the stack.
In any 使用者 interface 現在のing the 現在の Undo or Redo 活動／戦闘s to the 使用者, a hidden 活動／戦闘 will not be 名簿（に載せる）／表（にあげる）d.

A new undo 活動／戦闘 will be 追加するd to the undo stack. As long as the 状況 is not left, every undo 活動／戦闘追加するd to the stack will be 扱う／治療するd as sub 活動／戦闘. This means it will not be 直接／まっすぐに accessible at the undo 経営者／支配人, not appear in any 使用者 interface, and cannot be 分かれて undone or re-done.

Each call to enterHiddenUndoContext must be paired by a call to leaveUndoContext, さもなければ, the 文書's undo stack is left in an inconsistent 明言する／公表する.

Undo 状況s can be nested, i.e. it is 合法的 to call enterUndoContext and enterHiddenUndoContext 多重の times without calling leaveUndoContext inbetween.

Throws

EmptyUndoStackException if the undo stack is 現在／一般に empty, in which 事例／患者 it is impossible to 押し進める a hidden undo 活動／戦闘の上に it.

See also

enterUndoContext, leaveUndoContext

leaveUndoContext

無効の
leaveUndoContext()
raises(	::com::sun::星／主役にする::util::InvalidStateException );

Description

leaves the undo 状況以前 opened 経由で enterUndoContext それぞれ enterHiddenUndoContext.

If no undo 活動／戦闘 has been 追加するd since the 状況 has been opened, the 状況 is not only left, but silently 除去するd, and does not 与える／捧げる to the undo stack at all. In this 事例／患者, possible listeners will be 通知するd 経由で XUndoManagerListener::cancelledContext.

さもなければ, the undo 状況 will be の近くにd, and 追加するd to the Undo stack; the redo stack will be （疑いを）晴らすd, and listeners will be 通知するd 経由で XUndoManagerListener::leftContext resp. XUndoManagerListener::leftHiddenContext

Throws

::com::sun::星／主役にする::util::InvalidStateException if no undo 状況 is 現在／一般に open.

addUndoAction

無効の
addUndoAction(	[in] XUndoAction	i_action )
raises(	::com::sun::星／主役にする::lang::IllegalArgumentException );

Description

追加するs the given undo 活動／戦闘 to the undo stack.

The redo stack is （疑いを）晴らすd when a new 活動／戦闘 is 押し進めるd の上に the undo stack.

The Undo 経営者／支配人 takes 所有権 of any 活動／戦闘s 押し進めるd の上に the undo stack. This means that if the 活動／戦闘 is finally 除去するd from the Undo 経営者／支配人's 支配（する）／統制する (e.g. by calling （疑いを）晴らす resp. clearRedo), it will be 性質の／したい気がして, as long as it supports the XComponent interface.

If the Undo 経営者／支配人 is locked at the moment the method is called, the call will be ignored, and the undo 活動／戦闘 will すぐに be 性質の／したい気がして, if applicable.

Throws

::com::sun::星／主役にする::lang::IllegalArgumentException if the given undo 活動／戦闘 is NULL.

undo

無効の
undo()
raises(	EmptyUndoStackException, UndoContextNotClosedException, UndoFailedException );

Description

逆戻りするs the most 最近の活動／戦闘 on the 文書.

効果的に, invoking this method will

invoke XUndoAction::undo on the 最高の，を越す-most 活動／戦闘 of the undo stack
move this undo 活動／戦闘 from the undo stack to the redo stack

Throws

EmptyUndoStackException if the undo stack is 現在／一般に empty

Throws

UndoContextNotClosedException if there 現在／一般に is an open undo 状況

Throws

UndoFailedException if the invocation of XUndoAction::undo raised this exception. In this 事例／患者, the undo stack of the undo 経営者／支配人 will have been （疑いを）晴らすd.

See also

redo, enterUndoContext

redo

無効の
redo()
raises(	EmptyUndoStackException, UndoContextNotClosedException, UndoFailedException );

Description

replays the 活動／戦闘 on the 文書 which has most recently been undone

効果的に, invoking this method will

invoke XUndoAction::redo on the 最高の，を越す-most 活動／戦闘 of the redo stack
move this 活動／戦闘 from the redo stack to the undo stack

Throws

EmptyUndoStackException when the Redo stack is 現在／一般に empty

Throws

UndoContextNotClosedException if there 現在／一般に is an open undo 状況

Throws

UndoFailedException if the invocation of XUndoAction::redo raised this exception. In this 事例／患者, the redo stack of the undo 経営者／支配人 will have been （疑いを）晴らすd.

See also

undo

isUndoPossible

boolean
isUndoPossible();

Description: 決定するs whether undo can reasonably be 推定する／予想するd to 後継する.
Returns: 誤った if and only if the undo stack is 現在／一般に empty, or there is an open and not-yet-の近くにd undo 状況.

isRedoPossible

boolean
isRedoPossible();

Description: 決定するs whether redo can reasonably be 推定する／予想するd to 後継する.
Returns: 誤った if and only if the redo stack is 現在／一般に empty, or there is an open and not-yet-の近くにd undo 状況.

getCurrentUndoActionTitle

string
getCurrentUndoActionTitle()
raises(	EmptyUndoStackException );

Description: returns the 肩書を与える of the 最高の，を越す-most 活動／戦闘 on the undo stack
Throws: EmptyUndoStackException when the undo stack is 現在／一般に empty
See also: XUndoAction::肩書を与える

getCurrentRedoActionTitle

string
getCurrentRedoActionTitle()
raises(	EmptyUndoStackException );

Description: returns the 肩書を与える of the 最高の，を越す-most 活動／戦闘 on the Redo stack
Throws: EmptyUndoStackException when the Redo stack is 現在／一般に empty
See also: XUndoAction::肩書を与える

getAllUndoActionTitles

sequence< string >
getAllUndoActionTitles();

Description: returns the 肩書を与えるs of all 活動／戦闘s 現在／一般に on the undo stack, from 最高の，を越す to 底（に届く）
See also: XUndoAction::肩書を与える

getAllRedoActionTitles

sequence< string >
getAllRedoActionTitles();

Description: returns the 肩書を与えるs of all 活動／戦闘s 現在／一般に on the Redo stack, from 最高の，を越す to 底（に届く）
See also: XUndoAction::肩書を与える

（疑いを）晴らす

無効の
（疑いを）晴らす()
raises(	UndoContextNotClosedException );

Description: （疑いを）晴らすs the undo and the redo stack.; All 活動／戦闘s will be 除去するd from both the Undo and the Redo stack. 活動／戦闘s which 器具／実施する the ::com::sun::星／主役にする::lang::XComponent interface will be 性質の／したい気がして.
Throws: UndoContextNotClosedException if the method is invoked while an undo 状況 is still open

clearRedo

無効の
clearRedo()
raises(	UndoContextNotClosedException );

Description: （疑いを）晴らすs the redo stack.; All 活動／戦闘s will be 除去するd from the Redo stack. 活動／戦闘s which 器具／実施する the ::com::sun::星／主役にする::lang::XComponent interface will be 性質の／したい気がして.
Throws: UndoContextNotClosedException if the method is invoked while an undo 状況 is still open

reset

無効の
reset();

Description

resets the Undo 経営者／支配人

In particular, this method will

除去する all locks from the undo 経営者／支配人
の近くに all open undo 状況s
（疑いを）晴らす the undo stack
（疑いを）晴らす the redo stack

公式文書，認める that possible listeners will not get notifications for the 選び出す／独身 parts of the reset, i.e. there will be no 選び出す／独身 XUndoManagerListener::allActionsCleared, XUndoManagerListener::leftContext, etc., notifications. Instead, listeners will be 通知するd of the reset by calling their XUndoManagerListener::resetAll method.

addUndoManagerListener

無効の
addUndoManagerListener(	[in] XUndoManagerListener	i_listener );

Description: 追加するs a listener to be 通知するd of changes in the Undo/Redo stacks.

removeUndoManagerListener

無効の
removeUndoManagerListener(	[in] XUndoManagerListener	i_listener );

Description: 除去するs a 以前追加するd listener

最高の，を越す of Page

Copyright © 2013, The Apache ソフトウェア創立／基礎, Licensed under the Apache License, 見解／翻訳／版 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache ソフトウェア創立／基礎. Other 指名するs may be trademarks of their 各々の owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Undo

Redo

Undo 状況s

Hidden Undo 活動／戦闘s

Locking