textbender.a.u.locusPoint
Interface LocusPoint

All Superinterfaces:

PropertyChangeListenerR.Registry, PropertyChangeListenerR.RegistryN, Remote

All Known Implementing Classes:

LocusPoint1

public interface LocusPoint
extends PropertyChangeListenerR.RegistryN, Remote

The locus-point service. A single instance runs on the local host. Clients may obtain a reference to it from the service registry:

     LocusPoint locusPoint = serviceRegistry.getService( LocusPoint.class );
     

Method Summary

String	getLocus() Returns the locus currently pointed to, on the desktop.
boolean	isEnabled() Returns true iff locus-point is enabled.
void	setEnabled(boolean enabled) Enables or disables locus-point.
void	setLocus(String newLocus) Sets the locus currently pointed to.

Methods inherited from interface PropertyChangeListenerR.RegistryN

addPropertyChangeListener, disabledPropertyChangeListener

Methods inherited from interface PropertyChangeListenerR.Registry

addPropertyChangeListener, disabledPropertyChangeListener

Method Detail

getLocus

@ThreadSafe
String getLocus()
                throws RemoteException

Returns the locus currently pointed to, on the desktop. The return value is bound to property name 'locus'. Property change events may be coalesced (intermediate events skipped).

Returns:

the locus pointed to, or null if none

Throws:

RemoteException

See Also:

setLocus(String)

setLocus

@ThreadSafe
void setLocus(String newLocus)
              throws RemoteException

Sets the locus currently pointed to.

Throws:

RemoteException

See Also:

getLocus()

isEnabled

boolean isEnabled()
                  throws RemoteException

Returns true iff locus-point is enabled. The return value is bound to property name 'enabled'.

Throws:

RemoteException

See Also:

setEnabled(boolean)

setEnabled

void setEnabled(boolean enabled)
                throws RemoteException

Enables or disables locus-point.

Throws:

RemoteException

See Also:

isEnabled()