Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: form :: validation ::
unpublished | interface XValidator |
Usage Restrictions not published Description specifies a component able to validate (the content of) other components Validators support simple validity checks and retrieving justifications for invalidity. Validators may additionally support dynamic validity constraints. In such a case, the validity of a given value may change, without the value changing itself. To be notified about this, interested components should register as XValidityConstraintListener. See also XValidatable

Methods' Summary
isValid | determines whether the given value is valid
explainInvalid | retrieves a justification for the invalidity of the given value
addValidityConstraintListener | registers the given validity listener.
removeValidityConstraintListener | revokes the given validity listener

Methods' Details
isValid
boolean
isValid( | [in] any | Value );
Description determines whether the given value is valid Parameter aValue the value to check for validity Returns true if and only if the value is considered valid.
explainInvalid
string
explainInvalid( | [in] any | Value );
Description retrieves a justification for the invalidity of the given value Parameter aValue the value which has been recognized as being invalid Returns a human-readable string, which explains why the given value is considered invalid.
addValidityConstraintListener
void
addValidityConstraintListener( | [in] XValidityConstraintListener | Listener )
raises( | ::com::sun::star::lang::NullPointerException );
Description registers the given validity listener. Usually, an XValidatable instance will also add itself as validity listener, as soon as the validator is introduced to it. Implementations which do not support dynamic validity constraints should simply ignore this call. Throws ::com::sun::star::lang::NullPointerException if the given listener is NULL See also XValidityConstraintListener
removeValidityConstraintListener
void
removeValidityConstraintListener( | [in] XValidityConstraintListener | Listener )
raises( | ::com::sun::star::lang::NullPointerException );
Description revokes the given validity listener Throws ::com::sun::star::lang::NullPointerException if the given listener is NULL See also XValidityConstraintListener

Top of Page

Copyright © 2000, 2014 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.