org.uberfire.client.mvp

Interface LockManager

All Known Implementing Classes:

LockManagerImpl

public interface LockManager

Provides functionality to lock a file or directory, associated with a widget (i.e a workbench screen or editor).

Method Summary

Methods

Modifier and Type	Method and Description
void	acquireLockOnDemand() Registers DOM handlers to detect changes and, if required, tries to acquire a lock.
void	init(LockTarget lockTarget) Retrieves the latest lock information for the provided target and fires events to update the corresponding UI.
void	onFocus() Notifies this lock manager that the lock target's widget got focus to initialize widget-specific state i.e. to publish JavaScript methods for lock management which can be used by non-native editors (i.e editors that are rendered on the server).
void	releaseLock() Releases the previously acquired lock.

Method Detail

init

void init(LockTarget lockTarget)

Retrieves the latest lock information for the provided target and fires events to update the corresponding UI.

Parameters:

lockTarget - the LockTarget providing information about what to lock.

onFocus

void onFocus()

Notifies this lock manager that the lock target's widget got focus to initialize widget-specific state i.e. to publish JavaScript methods for lock management which can be used by non-native editors (i.e editors that are rendered on the server). The lock manager must be initialized before calling this method (see init(LockTarget)).

acquireLockOnDemand

void acquireLockOnDemand()

Registers DOM handlers to detect changes and, if required, tries to acquire a lock. If the target is already locked and the lock can't be acquired, the user will be notified and the lock target's reload runnable will be executed. Errors in the execution of this method are propagated to the global RPC/MessageBus error handler. The lock manager must be initialized before calling this method (see init(LockTarget)).

releaseLock

void releaseLock()

Releases the previously acquired lock. Errors in the execution of this method are propagated to the global RPC/MessageBus error handler.