|
LibreOffice
LibreOffice 25.2 SDK API Reference
|
is a convenience interface for accessing several aspects of a form component which supports validation. More...
import"XValidatableFormComponent.idl";
Public Member Functions | |
| boolean | isValid () |
| determines whether the current value of the component passed the validity test at the validator. More... | |
| any | getCurrentValue () |
| retrieves the current value of the component. More... | |
| void | addFormComponentValidityListener ([in] XFormComponentValidityListener Listener) raises ( com::sun::star::lang::NullPointerException ) |
| registers the given listener. More... | |
| void | removeFormComponentValidityListener ([in] XFormComponentValidityListener Listener) raises ( com::sun::star::lang::NullPointerException ) |
| registers the given listener. More... | |
Public Member Functions inherited from XValidatable | |
| void | setValidator ([in] XValidator Validator) raises ( com::sun::star::util::VetoException ) |
| sets an external instance which is able to validate the component More... | |
| XValidator | getValidator () |
| retrieves the external instance which is currently used to validate the component More... | |
Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
is a convenience interface for accessing several aspects of a form component which supports validation.
A validatable form component has two aspects which other parties might be interested in:
An XValidatableFormComponent allows to easily access both of these aspects.
Note that all of the information provided at this interface can also obtained by other means, but much more inconveniently.
| void addFormComponentValidityListener | ( | [in] XFormComponentValidityListener | Listener | ) | |
| raises | ( | com::sun::star::lang::NullPointerException | |||
| ) | |||||
registers the given listener.
XFormComponentValidityListeners are called whenever any of the aspects of the validatable form component (the validity flag, or the value) changed.
| com::sun::star::lang::NullPointerException | if the given listener is NULL |
| any getCurrentValue | ( | ) |
retrieves the current value of the component.
The type of the current value, as well as it's semantics, depend on the service implementing this interface.
Again, this is a convenience method. For example, for a com::sun::star::form::component::FormattedField, calling this method is equivalent to retrieving the com::sun::star::awt::UnoControlFormattedFieldModel::EffectiveValue.
If no validator has been set (XValidatable::setValidator()), the value returned here is defined by the service implementing this interface.
| boolean isValid | ( | ) |
determines whether the current value of the component passed the validity test at the validator.
Calling this is equal to calling XValidator::isValid() with the current value (see getCurrentValue()) of the component, where the validator is obtained via XValidatable::getValidator().
If no validator has been set (XValidatable::setValidator()), this method returns true.
| void removeFormComponentValidityListener | ( | [in] XFormComponentValidityListener | Listener | ) | |
| raises | ( | com::sun::star::lang::NullPointerException | |||
| ) | |||||
registers the given listener.
| com::sun::star::lang::NullPointerException | if the given listener is NULL |
1.8.14