Skip to content

A11y: Allow to provide color names as content descriptions #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eltos merged 2 commits into from
Apr 8, 2025
Merged

A11y: Allow to provide color names as content descriptions #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4bc967
A11y: Allow to provide color names as content descriptions
mtotschnig Mar 31, 2025
d1e6d27
Without provided color name, read RGB value
mtotschnig Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions simpledialogfragments/src/main/java/eltos/simpledialogfragment/color/ColorView.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
import android.widget.FrameLayout;
import android.widget.ImageView;

import java.util.Locale;

import eltos.simpledialogfragment.R;


Expand Down Expand Up @@ -108,12 +110,17 @@ public void setStyle(Style style){
return mColor;
}

/**
* Will implicitly set content description. Thus custom content description must be set after this
* method is called
*/
public void setColor(@ColorInt int color) {
if ((color & 0xFF000000) == 0 && color != 0){ // if alpha value omitted, set now
color = color | 0xFF000000;
}
if (mColor != color) {
mColor = color;
setContentDescription(colorToRGBString(mColor));
update();
}
}
Expand Down Expand Up @@ -289,6 +296,12 @@ public static boolean isColorDark(@ColorInt int color) {
return Color.HSVToColor(hsv);
}

public static String colorToRGBString(int color) {
int red = Color.red(color);
int green = Color.green(color);
int blue = Color.blue(color);
return String.format(Locale.ROOT, "RGB(%d, %d, %d)", red, green, blue);
}

}

52 changes: 39 additions & 13 deletions simpledialogfragments/src/main/java/eltos/simpledialogfragment/color/SimpleColorDialog.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import androidx.annotation.ArrayRes;
import androidx.annotation.ColorInt;
import androidx.annotation.NonNull;
import androidx.core.util.Pair;

import android.util.TypedValue;
import android.view.View;
Expand Down Expand Up @@ -95,6 +96,28 @@ public SimpleColorDialog colors(Context context, @ArrayRes int colorArrayRes){
return colors(context.getResources().getIntArray(colorArrayRes));
}

/**
* Sets the color names for accessibility purpose
*
* @param colorNames array of names that match the colors defined via {@link #colors(int[])}
* @return this instance
*/
public SimpleColorDialog colorNames(String[] colorNames){
getArgs().putStringArray(COLOR_NAMES, colorNames);
return this;
}

/**
* Sets the color names for accessibility purpose
*
* @param context a context to resolve the resource
* @param colorNameArrayRes String array resource id
* @return this instance
*/
public SimpleColorDialog colorNames(Context context, @ArrayRes int colorNameArrayRes){
return colorNames(context.getResources().getStringArray(colorNameArrayRes));
}

/**
* Sets the initially selected color
*
Expand Down Expand Up @@ -183,9 +206,6 @@ public SimpleColorDialog showOutline(@ColorInt int color){
return setArg(OUTLINE, color);
}




public static final @ColorInt int[] DEFAULT_COLORS = new int[]{
0xfff44336, 0xffe91e63, 0xff9c27b0, 0xff673ab7,
0xff3f51b5, 0xff2196f3, 0xff03a9f4, 0xff00bcd4,
Expand All @@ -206,6 +226,8 @@ public SimpleColorDialog showOutline(@ColorInt int color){
private static final String SELECTED = TAG + "selected";
private static final String OUTLINE = TAG + "outline";

private static final String COLOR_NAMES = TAG + "color_names";

private @ColorInt int mCustomColor = NONE;
private @ColorInt int mSelectedColor = NONE;

Expand Down Expand Up @@ -256,7 +278,7 @@ protected AdvancedAdapter onCreateAdapter() {
// Selector provided by ColorView
getListView().setSelector(new ColorDrawable(Color.TRANSPARENT));

return new ColorAdapter(colors, custom);
return new ColorAdapter(colors, getArgs().getStringArray(COLOR_NAMES), custom);
}

private int indexOf(int[] array, int item){
Expand Down Expand Up @@ -349,19 +371,19 @@ protected Bundle onResult(int which) {
}


protected class ColorAdapter extends AdvancedAdapter<Integer>{
protected class ColorAdapter extends AdvancedAdapter<Pair<Integer, String>>{

public ColorAdapter(int[] colors, boolean addCustomField){
public ColorAdapter(int[] colors, String[] contentDescriptions, boolean addCustomField){
if (colors == null) colors = new int[0];

Integer[] cs = new Integer[colors.length + (addCustomField ? 1 : 0)];
Pair<Integer, String>[] cs = new Pair[colors.length + (addCustomField ? 1 : 0)];
for (int i = 0; i < colors.length; i++) {
cs[i] = colors[i];
cs[i] = Pair.create(colors[i], contentDescriptions != null && contentDescriptions.length > i ? contentDescriptions[i] : null);
}
if (addCustomField){
cs[cs.length-1] = PICKER;
cs[cs.length-1] = Pair.create(PICKER, getString(R.string.color_picker));
}
setData(cs, Long::valueOf);
setData(cs, pair -> pair.first.longValue());
}

@Override
Expand All @@ -374,14 +396,18 @@ public View getView(int position, View convertView, ViewGroup parent) {
item = new ColorView(getContext());
}

int color = getItem(position);
Pair<Integer, String> pair = getItem(position);

if ( color == PICKER){
if (pair.first == PICKER){
item.setColor(mCustomColor);
item.setStyle(ColorView.Style.PALETTE);
item.setContentDescription(getString(R.string.color_picker) + (mCustomColor == NONE ? "" : ": " + ColorView.colorToRGBString(mCustomColor)));
} else {
item.setColor(getItem(position));
item.setColor(pair.first);
item.setStyle(ColorView.Style.CHECK);
if (pair.second != null) {
item.setContentDescription(pair.second);
}
}

@ColorInt int outline = getArgs().getInt(OUTLINE, ColorView.NONE);
Expand Down
23 changes: 23 additions & 0 deletions simpledialogfragments/src/main/java/eltos/simpledialogfragment/form/ColorField.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ public class ColorField extends FormElement<ColorField, ColorViewHolder> {
private @ColorInt int preset = NONE;
private int presetId = NO_ID;
protected int[] colors = SimpleColorDialog.DEFAULT_COLORS;
protected String[] colorNames = null;
protected boolean allowCustom = true;
protected int outline = NONE;

Expand Down Expand Up @@ -100,6 +101,28 @@ public ColorField colors(@ColorInt int[] colors){
return this;
}

/**
* Sets the color names for accessibility purpose
*
* @param colorNames array of names that match the colors defined via {@link #colors(int[])}
* @return this instance
*/
public ColorField colorNames(String[] colorNames) {
this.colorNames = colorNames;
return this;
}

/**
* Sets the color names for accessibility purpose
*
* @param context a context to resolve the resource
* @param colorNameArrayRes String array resource id
* @return this instance
*/
public ColorField colorNames(Context context, @ArrayRes int colorNameArrayRes){
return colorNames(context.getResources().getStringArray(colorNameArrayRes));
}

/**
* Sets the color pallet to choose from
* May be one of {@link SimpleColorDialog#MATERIAL_COLOR_PALLET},
Expand Down
9 changes: 9 additions & 0 deletions simpledialogfragments/src/main/java/eltos/simpledialogfragment/form/ColorViewHolder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ protected void setUpView(View view, final Context context, Bundle savedInstanceS
colorView.setOnClickListener(v -> actions.showDialog(SimpleColorDialog.build()
.title(field.getText(context))
.colors(field.colors)
.colorNames(field.colorNames)
.allowCustom(field.allowCustom)
.colorPreset(colorView.getColor())
.neut(),
Expand All @@ -99,6 +100,14 @@ protected void setUpView(View view, final Context context, Bundle savedInstanceS

private void setColor(@ColorInt int color){
colorView.setColor(color);
if (field.colorNames != null && field.colorNames.length >= field.colors.length) {
for (int i = 0; i < field.colors.length; i++) {
if (field.colors[i] == color) {
colorView.setContentDescription(field.colorNames[i]);
break;
}
}
}
clearButton.setVisibility(field.required || colorView.getColor() == ColorView.NONE ? View.GONE : View.VISIBLE);
}

Expand Down
1 change: 1 addition & 0 deletions simpledialogfragments/src/main/res/layout/simpledialogfragment_form_item_color.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
android:layout_gravity="center"
android:scaleType="fitCenter"
android:visibility="gone"
android:contentDescription="@string/clear_color"
android:src="@drawable/ic_clear_search" />


Expand Down
2 changes: 2 additions & 0 deletions simpledialogfragments/src/main/res/values/strings.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,6 @@
<string name="date">Date</string>
<string name="time">Time</string>
<string name="clear">Clear</string>
<string name="color_picker">Color picker</string>
<string name="clear_color">Clear color</string>
</resources>
13 changes: 9 additions & 4 deletions testApp/src/main/java/eltos/simpledialogfragments/MainActivity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,13 +393,16 @@ public void showColorPicker(View view){
pallet == SimpleColorDialog.BEIGE_COLOR_PALLET ? SimpleColorDialog.AUTO :
SimpleColorDialog.NONE;

SimpleColorDialog.build()
SimpleColorDialog dialog = SimpleColorDialog.build()
.title(R.string.pick_a_color)
.colors(this, pallet)
.colorPreset(color)
.allowCustom(true)
.showOutline(outline)
.show(this, COLOR_DIALOG);
.showOutline(outline);
if (pallet == SimpleColorDialog.MATERIAL_COLOR_PALLET) {
dialog.colorNames(this, R.array.material_color_names);
}
dialog.show(this, COLOR_DIALOG);

/** Results: {@link MainActivity#onResult} **/

Expand Down Expand Up @@ -551,7 +554,9 @@ public void showForm(View view){
Input.plain(COUNTRY).hint(R.string.country)
.inputType(InputType.TYPE_CLASS_TEXT | InputType.TYPE_TEXT_FLAG_CAP_SENTENCES)
.suggest(R.array.countries_locale).forceSuggestion(),
ColorField.picker(COLOR).label(R.string.favourite_color),
ColorField.picker(COLOR).colors(SimpleColorDialog.DEFAULT_COLORS)
.colorNames(this,R.array.material_color_names)
.label(R.string.favourite_color),
Input.email(EMAIL).required(),
Check.box(NEWSLETTER).label(R.string.receive_newsletter).check(true),
Input.password(PASSWORD).max(20).required().validatePatternStrongPassword(),
Expand Down
22 changes: 21 additions & 1 deletion testApp/src/main/res/values/arrays.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,25 @@
<item>Intersex</item>
<item>Dyadic</item>
</string-array>

<string-array name="material_color_names">
<item>red</item>
<item>magenta</item>
<item>purple</item>
<item>deep purple</item>
<item>indigo</item>
<item>blue</item>
<item>light blue</item>
<item>cyan</item>
<item>teal</item>
<item>green</item>
<item>light green</item>
<item>lime</item>
<item>yellow</item>
<item>amber</item>
<item>orange</item>
<item>deep orange</item>
<item>brown</item>
<item>gray</item>
<item>blue gray</item>
</string-array>
</resources>
Loading