public interface PhoneField<F extends PhoneField<F>> extends Field<F>
Represents the metadata for a FieldTypes.PHONE field. A phone field is useful for
situations when you are managing a phone property.
A dynamic field can be used to switch between one field type and another, for example:
Fields.phone()
.placeholderCountryCode("1");
| Modifier and Type | Interface and Description |
|---|---|
static class |
PhoneField.Attributes |
| Modifier and Type | Method and Description |
|---|---|
default F |
excludeCountryCode()
Excludes the country code input for this phone field.
|
default F |
excludeExtension()
Excludes the extension input for this phone field.
|
default F |
includeCountryCode()
Include the country code input for this phone field.
|
default F |
includeExtension()
Include the country code input for this phone field.
|
default F |
placeholderCountryCode(String placeholder)
Configures the the field to have the placeholder with the desired country code
ex.
|
default F |
placeholderExtension(String placeholder)
Configures the the field to have the placeholder with the desired extension
ex.
|
default F |
placeholderPhoneNumber(String placeholder)
Configures the the field to have the placeholder with the desired extension
ex.
|
decorated, defaultValue, getDefaultValue, getName, getPlaceholder, getRequiredMessage, getValidationSchema, isReadOnly, isRequired, isShowInQueryBuilder, name, notReadOnly, notRequired, placeholder, placeholder, readOnly, readOnly, required, required, required, required, requiredMessage, requiredMessage, setDefaultValue, setName, setPlaceholder, setReadOnly, setRequired, setRequiredMessage, setShowInQueryBuilder, setValidationSchema, validationMethod, validationSchema, validationSchemagetHelpText, getHint, getTooltip, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltipaddAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, typecompareTodefault F includeCountryCode()
excludeCountryCode() to
exclude this input
ex. the number +1 (555) 555-5555 would include the field to enter 1 as the area code. which
the result would be an object like:
{ countryCode: '1', phoneNumber: '5555555555' }default F includeExtension()
excludeExtension() to exclude
this input
ex. the number +1 (555) 555-5555 ext. 123 would include the field to enter 123 as the
extension. which the result would be an object like:
{ extension: '123', phoneNumber: '5555555555' }default F excludeCountryCode()
includeCountryCode() to include this input
ex. the number +1 (555) 555-5555 would NOT include the field to enter 1 as the area code.
which the result would be an object like:
{ phoneNumber: '5555555555' }default F excludeExtension()
includeExtension() to include this input
ex. the number +1 (555) 555-5555 ext. 123 would NOT include the field to enter 123 as the
extension. which the result would be an object like:
{ phoneNumber: '5555555555' }default F placeholderCountryCode(String placeholder)
default F placeholderExtension(String placeholder)
Copyright © 2021. All rights reserved.