com.github.bordertech.wcomponents.examples.I18nExample Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wcomponents-examples Show documentation
There is a newer version: 1.5.36
package com.github.bordertech.wcomponents.examples;

import com.github.bordertech.wcomponents.Action;
import com.github.bordertech.wcomponents.ActionEvent;
import com.github.bordertech.wcomponents.HeadingLevel;
import com.github.bordertech.wcomponents.Margin;
import com.github.bordertech.wcomponents.MessageContainer;
import com.github.bordertech.wcomponents.Size;
import com.github.bordertech.wcomponents.UIContextHolder;
import com.github.bordertech.wcomponents.WAjaxControl;
import com.github.bordertech.wcomponents.WButton;
import com.github.bordertech.wcomponents.WCheckBox;
import com.github.bordertech.wcomponents.WDateField;
import com.github.bordertech.wcomponents.WFieldLayout;
import com.github.bordertech.wcomponents.WHeading;
import com.github.bordertech.wcomponents.WLabel;
import com.github.bordertech.wcomponents.WMessages;
import com.github.bordertech.wcomponents.WPanel;
import com.github.bordertech.wcomponents.WTextField;
import com.github.bordertech.wcomponents.examples.common.ClientValidationTemplate;
import com.github.bordertech.wcomponents.examples.common.ExplanatoryText;
import com.github.bordertech.wcomponents.layout.FlowLayout;
import com.github.bordertech.wcomponents.layout.FlowLayout.Alignment;
import com.github.bordertech.wcomponents.validation.Diagnostic;
import com.github.bordertech.wcomponents.validation.ValidatingAction;
import com.github.bordertech.wcomponents.validation.WValidationErrors;
import java.util.Date;
import java.util.List;
import java.util.Locale;

/**
 * This example demonstrates use of internationalisation.
 *
 * @author Yiannis Paschalidis
 * @since 1.0.0
 */
public class I18nExample extends WPanel implements MessageContainer {

	/**
	 * Used to display info/warning/error messages to the user.
	 */
	private final WMessages messages = new WMessages();

	/**
	 * Toggle whether to use client validation.
	 */
	private final WCheckBox useClientValidation = new WCheckBox();

	/**
	 * Template to include client validation.
	 */
	private final ClientValidationTemplate jsPlainTextTemplate = new ClientValidationTemplate();

	/**
	 * Creates an I18nExample.
	 */
	public I18nExample() {
		useClientValidation.setActionOnChange(new Action() {
			@Override
			public void execute(final ActionEvent event) {
				jsPlainTextTemplate.setVisible(useClientValidation.isSelected());
			}
		});

		setLayout(new FlowLayout(Alignment.VERTICAL));
		add(messages);

		WPanel buttons = new WPanel(WPanel.Type.FEATURE);
		buttons.setLayout(new FlowLayout(Alignment.LEFT, Size.LARGE));
		add(buttons);

		buttons.add(new ChangeLocaleButton(null));
		buttons.add(new ChangeLocaleButton(new Locale("en")));
		buttons.add(new ChangeLocaleButton(new Locale("fr", "CA")));
		buttons.add(new ChangeLocaleButton(new Locale("en", "US")));

		add(new WHeading(HeadingLevel.H2, "Internationalisation example"));

		final WTextField nameField = new WTextField();
		final ExplanatoryText helloWorldText = new ExplanatoryText();
		final WDateField dateField = new WDateField();

		nameField.setMandatory(true);
		dateField.setMandatory(true);
		dateField.setMaxDate(new Date());
		helloWorldText.setVisible(false);

		WButton actionButton = new WButton("SUBMIT_FORM");

		final WFieldLayout layout = new WFieldLayout();
		add(layout);
		layout.setMargin(new Margin(null, null, Size.LARGE, null));
		layout.addField("CLIENT_SIDE_PROMPT", useClientValidation);
		layout.addField(new WLabel("ENTER_NAME_PROMPT"), nameField);
		layout.addField("DATE_PROMPT", dateField);
		layout.addField((WLabel) null, actionButton);

		final WHeading outputHeading = new WHeading(HeadingLevel.H3, "Output");
		outputHeading.setVisible(false);
		add(outputHeading);
		add(helloWorldText);
		add(jsPlainTextTemplate);
		add(new WAjaxControl(useClientValidation, this));

		nameField.setActionOnChange(new Action() {
			@Override
			public void execute(final ActionEvent event) {
				String name = nameField.getText();
				outputHeading.setVisible(!(name == null || "".equals(name)));
			}
		});

		actionButton.setAction(
			new ValidatingAction(messages.getValidationErrors(), I18nExample.this) {
				@Override
				public void executeOnValid(final ActionEvent event) {
					helloWorldText.setVisible(true);
					helloWorldText.setText("HELLO_NAME", nameField.getText());
				}

				@Override
				public void executeOnError(final ActionEvent event, final List diags) {
					super.executeOnError(event, diags);
					helloWorldText.setVisible(false);
					outputHeading.setVisible(false);
					helloWorldText.setText(null);
				}
			}
		);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public WMessages getMessages() {
		return messages;
	}

	/**
	 * This button is used to change the user's active locale to the given Locale.
	 */
	private static final class ChangeLocaleButton extends WButton {

		/**
		 * Creates a ChangeLocaleButton.
		 *
		 * @param locale the locale the button will switch to.
		 */
		private ChangeLocaleButton(final Locale locale) {
			setImage(getButtonImage(locale));
			// setRenderAsLink(true);
			setText("Change locale to " + (locale == null ? "default" : locale));

			setAction(new ValidatingAction(new WValidationErrors(), this) {
				@Override
				public void executeOnValid(final ActionEvent event) {
					UIContextHolder.getCurrent().setLocale(locale);
				}
			});
		}

		/**
		 * Return a button image for this button. The button images are present in the classpath, in the same location
		 * as the resource bundles.
		 *
		 * @param locale the locale to retrieve the image for.
		 * @return the image for the given locale.
		 */
		private String getButtonImage(final Locale locale) {
			return "/i18n/" + (locale == null ? "default" : locale) + ".png";
		}
	}
}