com.github.bordertech.wcomponents.examples.WTimeoutWarningOptionsExample 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.ActionEvent;
import com.github.bordertech.wcomponents.WButton;
import com.github.bordertech.wcomponents.WContainer;
import com.github.bordertech.wcomponents.WField;
import com.github.bordertech.wcomponents.WFieldLayout;
import com.github.bordertech.wcomponents.WLabel;
import com.github.bordertech.wcomponents.WNumberField;
import com.github.bordertech.wcomponents.WTimeoutWarning;
import com.github.bordertech.wcomponents.subordinate.Disable;
import com.github.bordertech.wcomponents.subordinate.Enable;
import com.github.bordertech.wcomponents.subordinate.Match;
import com.github.bordertech.wcomponents.subordinate.Rule;
import com.github.bordertech.wcomponents.subordinate.WSubordinateControl;
import com.github.bordertech.wcomponents.validation.Diagnostic;
import com.github.bordertech.wcomponents.validation.ValidatingAction;
import com.github.bordertech.wcomponents.validation.WValidationErrors;
import java.math.BigDecimal;
import java.util.List;

/**
 * This example is shows how WTimeoutWarning can be configured to show a warning at different times before the timeout
 * period and how the timeout period itself can be manipulated.
 *
 * The timeout warning will not appear if the timeout period is not set or is set to 0. The warning must be set to a
 * period less then the timeout and defaults to 20 seconds.
 *
 * @author Mark Reeves
 * @since 1.0.0
 */
public class WTimeoutWarningOptionsExample extends WContainer {

	/**
	 * The absolute minimum warning period is fixed in all themes as the WCAG 2.0 minimum requirement of 20 seconds.
	 */
	private static final int MIN_WARN = 20;
	/**
	 * The timeout must be greater than a theme-determined value otherwise the warning may not be able to be rendered.
	 * This is never less than 30 seconds but may be longer. If your example doesn't work - check your theme.
	 */
	private static final int MIN_EXPIRY = 60;

	/**
	 * The timeout warning.
	 */
	private WTimeoutWarning warning = new WTimeoutWarning(0);

	/**
	 * a field to set the timeout period.
	 */
	private final WNumberField timeoutNumberField = new WNumberField();
	/**
	 * a field to set the warning period.
	 */
	private final WNumberField warnAtNumberField = new WNumberField();

	private final WButton saveButton = new WButton("Set timeout config");

	private final WValidationErrors errors = new WValidationErrors();

	/**
	 * Construct example.
	 */
	public WTimeoutWarningOptionsExample() {
		add(warning);
		add(errors);

		final WFieldLayout layout = new WFieldLayout();
		add(layout);
		layout.setLabelWidth(25);

		timeoutNumberField.setMinValue(MIN_EXPIRY);
		timeoutNumberField.setNumber(MIN_EXPIRY);
		timeoutNumberField.setMandatory(true);

		WField timeoutField = layout.addField("Demonstration Timeout Period", timeoutNumberField);
		timeoutField.getLabel().setHint("Must be at least " + String.valueOf(MIN_EXPIRY));

		warnAtNumberField.setMinValue(MIN_WARN);
		WField warnField = layout.addField("Demonstration Warning Period", warnAtNumberField);
		warnField.getLabel().setHint(
				"Must be at least " + String.valueOf(MIN_WARN) + " and less than the value of the demonstration timeout period");

		layout.addField((WLabel) null, saveButton);

		WSubordinateControl control = new WSubordinateControl();
		add(control);
		Rule rule = new Rule(new Match(timeoutNumberField, "\\d+"));
		rule.addActionOnFalse(new Disable(saveButton));
		rule.addActionOnTrue(new Enable(saveButton));
		control.addRule(rule);

		saveButton.setAction(new ValidatingAction(errors, layout) {
			@Override
			public void validate(final List diags) {
				super.validate(diags);

				BigDecimal warnValue = warnAtNumberField.getValue();
				BigDecimal timeoutValue = timeoutNumberField.getValue();

				if (warnValue != null && warnValue.compareTo(timeoutValue) != -1) {
					diags.add(createErrorDiagnostic(warnAtNumberField,
							"The warning period must be less than the timeout period."));
				}
			}

			@Override
			public void executeOnValid(final ActionEvent event) {
				BigDecimal timeout = timeoutNumberField.getNumber();
				if (timeout != null) {
					warning.setTimeoutPeriod(timeout.intValue());
				} else {
					warning.setTimeoutPeriod(0);
				}
				BigDecimal warn = warnAtNumberField.getNumber();
				if (warn != null) {
					warning.setWarningPeriod(warn.intValue());
				}
			}
		});
	}
}