Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: form :: validation ::
unpublished | interface XValidatableFormComponent |
  Base Interfaces
      XValidatableFormComponent
      ┗ XValidatable
  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 inconveniently. 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

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.