Package org.uberfire.client.mvp

Class LockManagerImpl

java.lang.Object

org.uberfire.client.mvp.LockManagerImpl

All Implemented Interfaces:

LockManager

@Dependent
public class LockManagerImpl
extends Object
implements LockManager

Default implementation of LockManager using the VFSLockServiceProxy for lock management.

Constructor Summary

Constructors

Constructor	Description
LockManagerImpl()

Method Summary

Modifier and Type	Method	Description
void	acquireLock()	Attempts to acquire a lock where the consuming code knows a lock needs to be acquired.
void	acquireLockOnDemand()	Registers DOM handlers to detect changes on LockTarget.getWidget() and, if required (see LockDemandDetector), automatically tries to acquire a lock.
com.google.gwt.user.client.EventListener	acquireLockOnDemand(com.google.gwt.dom.client.Element element)
protected void	fireChangeTitleEvent()
protected void	fireUpdatedLockStatusEvent()
protected org.uberfire.backend.vfs.impl.LockInfo	getLockInfo()
org.uberfire.client.mvp.LockTarget	getLockTarget()
void	init(org.uberfire.client.mvp.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LockManagerImpl

public LockManagerImpl()

Method Detail

init

public void init(org.uberfire.client.mvp.LockTarget lockTarget)

Description copied from interface: LockManager

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

Specified by:

init in interface LockManager

Parameters:

lockTarget - the LockTarget providing information about what to lock.

onFocus

public void onFocus()

Description copied from interface: LockManager

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 LockManager.init(LockTarget)).

Specified by:

onFocus in interface LockManager

acquireLockOnDemand

public void acquireLockOnDemand()

Description copied from interface: LockManager

Registers DOM handlers to detect changes on LockTarget.getWidget() and, if required (see LockDemandDetector), automatically tries to acquire a lock. If the target is already locked by another user 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 LockManager.init(LockTarget)).

Specified by:

acquireLockOnDemand in interface LockManager

acquireLockOnDemand

public com.google.gwt.user.client.EventListener acquireLockOnDemand(com.google.gwt.dom.client.Element element)

acquireLock

public void acquireLock()

Description copied from interface: LockManager

Attempts to acquire a lock where the consuming code knows a lock needs to be acquired. If the target is already locked by another user and the lock cannot be acquired, the user will be notified and the lock target's reload runnable will be executed. Attempts to acquire a lock will always cause an ChangeTitleWidgetEvent to be fired. 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 LockManager.init(LockTarget)).

Specified by:

acquireLock in interface LockManager

releaseLock

public void releaseLock()

Description copied from interface: LockManager

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

Specified by:

releaseLock in interface LockManager

getLockTarget

public org.uberfire.client.mvp.LockTarget getLockTarget()

getLockInfo

protected org.uberfire.backend.vfs.impl.LockInfo getLockInfo()

fireChangeTitleEvent

protected void fireChangeTitleEvent()

fireUpdatedLockStatusEvent

protected void fireUpdatedLockStatusEvent()