Skip to content

Commit

Permalink
Add ErrorType and StringConverter in PhoneNumberLabel
Browse files Browse the repository at this point in the history 
Updated PhoneNumberLabel to handle different types of phoneNumber parsing exceptions more accurately. Also included added StringConverter to translate error types to human-readable error messages. Added documentation for clarity and understanding. Renamed the constant from NATIONAL_FOR_DEFAULT_COUNTRY_ONLY to NATIONAL_FOR_OWN_COUNTRY_ONLY to reflect its purpose more accurately.
  • Loading branch information
@dlemmermann
dlemmermann committed Nov 24, 2023
1 parent 6b0ceda commit ddcca09
Showing 1 changed file with 131 additions and 5 deletions.
136 changes: 131 additions & 5 deletions phonenumberfx/src/main/java/com/dlsc/phonenumberfx/PhoneNumberLabel.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

import com.dlsc.phonenumberfx.PhoneNumberField.Country;
import com.google.i18n.phonenumbers.NumberParseException;
import com.google.i18n.phonenumbers.NumberParseException.ErrorType;
import com.google.i18n.phonenumbers.PhoneNumberUtil;
import com.google.i18n.phonenumbers.Phonenumber;
import javafx.beans.property.*;
import javafx.css.PseudoClass;
import javafx.scene.control.*;
import javafx.util.StringConverter;

import java.util.Locale;
import java.util.Objects;
Expand Down Expand Up @@ -41,6 +43,7 @@ public PhoneNumberLabel() {
validProperty().addListener((obs, oldV, newV) -> pseudoClassStateChanged(INVALID_PSEUDO_CLASS, !newV));

rawPhoneNumber.addListener((obs, oldRawPhoneNumber, newRawPhoneNumber) -> {
errorType.set(null);
try {
Phonenumber.PhoneNumber phoneNumber;

Expand All @@ -51,7 +54,7 @@ public PhoneNumberLabel() {
nationalPhoneNumber.set(phoneNumberUtil.format(phoneNumber, PhoneNumberUtil.PhoneNumberFormat.NATIONAL));

switch (getStrategy()) {
case NATIONAL_FOR_DEFAULT_COUNTRY_ONLY:
case NATIONAL_FOR_OWN_COUNTRY_ONLY:
if (phoneNumber.getCountryCode() == getCountry().countryCode()) {
setText(getNationalPhoneNumber());
} else {
Expand All @@ -74,11 +77,19 @@ public PhoneNumberLabel() {

setTooltip(new Tooltip(phoneNumberUtil.format(phoneNumber, PhoneNumberUtil.PhoneNumberFormat.INTERNATIONAL)));
setValid(phoneNumberUtil.isValidNumber(phoneNumber));

} catch (NumberParseException e) {
ErrorType errorType = e.getErrorType();
if (errorType != null) {
this.errorType.set(errorType);
setTooltip(new Tooltip(getConverter().toString(errorType)));
} else {
setTooltip(new Tooltip(newRawPhoneNumber));
}

if (newRawPhoneNumber != null && newRawPhoneNumber.startsWith(getCountry().countryCodePrefix())) {
newRawPhoneNumber = newRawPhoneNumber.substring(getCountry().countryCodePrefix().length());
}

e164PhoneNumber.set("");
nationalPhoneNumber.set("");
setText(newRawPhoneNumber);
Expand All @@ -94,18 +105,113 @@ private void updateValidPseudoState() {
pseudoClassStateChanged(INVALID_PSEUDO_CLASS, !isValid());
}

// STRING CONVERTER

private final ObjectProperty<StringConverter<ErrorType>> converter = new SimpleObjectProperty<>(this, "converter", new StringConverter<>() {

@Override
public String toString(ErrorType errorType) {
if (errorType != null) {
switch (errorType) {
case INVALID_COUNTRY_CODE:
return "Invalid country code";
case NOT_A_NUMBER:
return "Invalid: not a number";
case TOO_SHORT_AFTER_IDD:
case TOO_SHORT_NSN:
return "Invalid: too short / not enough digits";
case TOO_LONG:
return "Invalid: too long / too many digits";
}
}
return null;
}

@Override
public ErrorType fromString(String string) {
return null;
}
});

public StringConverter<ErrorType> getConverter() {
return converter.get();
}

/**
* Returns the property that represents the converter for the error type.
* The converter is used to convert the error type to a string for display purposes.
*
* @return the property that represents the converter for the error type
*/
public ObjectProperty<StringConverter<ErrorType>> converterProperty() {
return converter;
}

public void setConverter(StringConverter<ErrorType> converter) {
this.converter.set(converter);
}

// ERROR TYPE

private final ObjectProperty<ErrorType> errorType = new SimpleObjectProperty<>(this, "errorType");

public final ErrorType getErrorType() {
return errorType.get();
}

/**
* Returns the error type property of the phone number field. The error type
* represents the type of error that occurred during the parsing of the phone
* number.
*
* @return the error type property
*/
public final ObjectProperty<ErrorType> errorTypeProperty() {
return errorType;
}

public final void setErrorType(ErrorType errorType) {
this.errorType.set(errorType);
}

/**
* Enumeration representing different strategies for displaying phone numbers.
*
* @see #setStrategy(Strategy)
*/
public enum Strategy {
NATIONAL_FOR_DEFAULT_COUNTRY_ONLY,

/**
* This value causes the label to show the phone number in a format appropriate
* for the country where the application is being used, while numbers from other
* countries will contain the countries prefix.
*/
NATIONAL_FOR_OWN_COUNTRY_ONLY,

/**
* This value causes the label to always show the phone number in international
* format including the country code prefix.
*/
ALWAYS_DISPLAY_INTERNATIONAL,
ALWAYS_DISPLAY_NATIONAL,

/**
* This value causes the label to always show the phone number in the national
* format, without the country code prefix.
*/
ALWAYS_DISPLAY_NATIONAL
}

private final ObjectProperty<Strategy> strategy = new SimpleObjectProperty<>(this, "strategy", Strategy.NATIONAL_FOR_DEFAULT_COUNTRY_ONLY);
// STRATEGY

private final ObjectProperty<Strategy> strategy = new SimpleObjectProperty<>(this, "strategy", Strategy.NATIONAL_FOR_OWN_COUNTRY_ONLY);

public final Strategy getStrategy() {
return strategy.get();
}

/**
* A property used to determine how the label will display the given phone number.
*/
public final ObjectProperty<Strategy> strategyProperty() {
return strategy;
}
Expand All @@ -114,6 +220,8 @@ public final void setStrategy(Strategy strategy) {
this.strategy.set(strategy);
}

// RAW PHONE NUMBER

private final StringProperty rawPhoneNumber = new SimpleStringProperty(this, "rawPhoneNumber");

/**
Expand All @@ -132,12 +240,18 @@ public final void setRawPhoneNumber(String rawPhoneNumber) {
rawPhoneNumberProperty().set(rawPhoneNumber);
}

// COUNTRY

private final ObjectProperty<Country> country = new SimpleObjectProperty<>(this, "country", Country.ofISO2(Locale.getDefault().getCountry()));

public final Country getCountry() {
return country.get();
}

/**
* The country where the field gets used. This property will be initially populated via
* a lookup of the default locale.
*/
public final ObjectProperty<Country> countryProperty() {
return country;
}
Expand All @@ -146,8 +260,13 @@ public final void setCountry(Country country) {
this.country.set(country);
}

// NATIONAL PHONE NUMBER

private final ReadOnlyStringWrapper nationalPhoneNumber = new ReadOnlyStringWrapper(this, "nationalPhoneNumber");

/**
* A representation of the phone number in the national format of the specified country.
*/
public final ReadOnlyStringProperty nationalPhoneNumberProperty() {
return nationalPhoneNumber.getReadOnlyProperty();
}
Expand All @@ -160,8 +279,13 @@ private void setNationalPhoneNumber(String nationalPhoneNumber) {
this.nationalPhoneNumber.set(nationalPhoneNumber);
}

// E164 PHONE NUMBER

private final ReadOnlyStringWrapper e164PhoneNumber = new ReadOnlyStringWrapper(this, "e164PhoneNumber");

/**
* A representation of the phone number in the international standard format E164.
*/
public final ReadOnlyStringProperty e164PhoneNumberProperty() {
return e164PhoneNumber.getReadOnlyProperty();
}
Expand All @@ -174,6 +298,8 @@ private void setE164PhoneNumber(String e164PhoneNumber) {
this.e164PhoneNumber.set(e164PhoneNumber);
}

// VALIDITY FLAG

private final ReadOnlyBooleanWrapper valid = new ReadOnlyBooleanWrapper(this, "valid");

/**
Expand Down

0 comments on commit ddcca09

Please sign in to comment.