Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: form ::

interface XLoadable
Description
provides functionality to implement objects which may be loaded.

The object is typically implemented by high-level objects which can connect to a data source.

See also
XLoadListener
Developers Guide
Forms - Loadable Forms

Methods' Summary
load loads the data.  
unload unloads the data.  
reload does a smart refresh of the object.  
isLoaded returns if the object is in loaded state.  
addLoadListener adds the specified listener to receive load-related events  
removeLoadListener removes the specified listener.  
Methods' Details
load
[oneway] void
load();

Description
loads the data.

If the data is already loaded (->isLoaded), then the method returns silently. In this case, you should use ->reload.

unload
[oneway] void
unload();

Description
unloads the data.
reload
[oneway] void
reload();

Description
does a smart refresh of the object.

The final state will be the same as if unload and load were called, but reload is the more efficient way to do the same. If the object isn't loaded, nothing happens.

isLoaded
boolean
isLoaded();

Description
returns if the object is in loaded state.
addLoadListener
[oneway] void
addLoadListener( [in] XLoadListener  aListener );

Description
adds the specified listener to receive load-related events
Parameter aListener
the listener to add.
removeLoadListener
[oneway] void
removeLoadListener( [in] XLoadListener  aListener );

Description
removes the specified listener.
Parameter aListener
the listener to remove.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.