java.beans
Interface Visibility

All Known Subinterfaces:
BeanContext sample code for java.beans.beancontext.BeanContext definition code for java.beans.beancontext.BeanContext , BeanContextServices sample code for java.beans.beancontext.BeanContextServices definition code for java.beans.beancontext.BeanContextServices
All Known Implementing Classes:
BeanContextServicesSupport sample code for java.beans.beancontext.BeanContextServicesSupport definition code for java.beans.beancontext.BeanContextServicesSupport , BeanContextSupport sample code for java.beans.beancontext.BeanContextSupport definition code for java.beans.beancontext.BeanContextSupport

public interface Visibility

Under some circumstances a bean may be run on servers where a GUI is not available. This interface can be used to query a bean to determine whether it absolutely needs a gui, and to advise the bean whether a GUI is available.

This interface is for expert developers, and is not needed for normal simple beans. To avoid confusing end-users we avoid using getXXX setXXX design patterns for these methods.


Method Summary
 boolean avoidingGui sample code for java.beans.Visibility.avoidingGui() definition code for java.beans.Visibility.avoidingGui() ()
          Determines whether this bean is avoiding using a GUI.
 void dontUseGui sample code for java.beans.Visibility.dontUseGui() definition code for java.beans.Visibility.dontUseGui() ()
          This method instructs the bean that it should not use the Gui.
 boolean needsGui sample code for java.beans.Visibility.needsGui() definition code for java.beans.Visibility.needsGui() ()
          Determines whether this bean needs a GUI.
 void okToUseGui sample code for java.beans.Visibility.okToUseGui() definition code for java.beans.Visibility.okToUseGui() ()
          This method instructs the bean that it is OK to use the Gui.
 

Method Detail

needsGui sample code for java.beans.Visibility.needsGui() definition code for java.beans.Visibility.needsGui()

boolean needsGui()
Determines whether this bean needs a GUI.

Returns:
True if the bean absolutely needs a GUI available in order to get its work done.

dontUseGui sample code for java.beans.Visibility.dontUseGui() definition code for java.beans.Visibility.dontUseGui()

void dontUseGui()
This method instructs the bean that it should not use the Gui.


okToUseGui sample code for java.beans.Visibility.okToUseGui() definition code for java.beans.Visibility.okToUseGui()

void okToUseGui()
This method instructs the bean that it is OK to use the Gui.


avoidingGui sample code for java.beans.Visibility.avoidingGui() definition code for java.beans.Visibility.avoidingGui()

boolean avoidingGui()
Determines whether this bean is avoiding using a GUI.

Returns:
true if the bean is currently avoiding use of the Gui. e.g. due to a call on dontUseGui().