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 :: validation ::

unpublished interface XValidatableFormComponent
Base Interfaces
XValidatableFormComponentXValidatable

XValidatable
(referenced interface's summary:)
specifies support for validating a component
Usage Restrictions
not published
Description
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:

  • The pure validity flag: Whatever the user enters in the component, this is either valid (relative to the active validator), or invalid.
  • The current value: Even if the validity flag does not change with the user input (e.g. because the user replaces one invalid value with another invalid value), observers might be interested in the current value, for example to include it in a feedback message to the user.

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

See also
XValidatable, XValidator

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

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.