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

interface XValidatableFormComponent
Base Interfaces
XValidatableFormComponentXValidatable

XValidatable

Methods' Summary
isValid determines whether the current value of the component passed the validity test at the validator.  
getCurrentValue retrieves the current value of the component.  
addFormComponentValidityListener registers the given listener.  
removeFormComponentValidityListener registers the given listener.  
Methods' Details
isValid
boolean
isValid();

Description
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.

getCurrentValue
any
getCurrentValue();

Description
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.

addFormComponentValidityListener
void
addFormComponentValidityListener( [in] XFormComponentValidityListener  Listener )
raises( ::com::sun::star::lang::NullPointerException );

Description
registers the given listener.

XFormComponentValidityListeners are called whenever any of the aspects of the validatable form component (the validity flag, or the value) changed.

Throws
::com::sun::star::lang::NullPointerException if the given listener is NULL
removeFormComponentValidityListener
void
removeFormComponentValidityListener( [in] XFormComponentValidityListener  Listener )
raises( ::com::sun::star::lang::NullPointerException );

Description
registers the given listener.
Throws
::com::sun::star::lang::NullPointerException if the given listener is NULL
Top of Page