com.github.bordertech.wcomponents.examples.theme.AccessKeyExample 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.theme;

import com.github.bordertech.wcomponents.RadioButtonGroup;
import com.github.bordertech.wcomponents.WButton;
import com.github.bordertech.wcomponents.WCheckBox;
import com.github.bordertech.wcomponents.WCheckBoxSelect;
import com.github.bordertech.wcomponents.WContainer;
import com.github.bordertech.wcomponents.WDropdown;
import com.github.bordertech.wcomponents.WFieldLayout;
import com.github.bordertech.wcomponents.WHorizontalRule;
import com.github.bordertech.wcomponents.WLabel;
import com.github.bordertech.wcomponents.WLink;
import com.github.bordertech.wcomponents.WMultiDropdown;
import com.github.bordertech.wcomponents.WMultiSelectPair;
import com.github.bordertech.wcomponents.WRadioButton;
import com.github.bordertech.wcomponents.WRadioButtonSelect;
import com.github.bordertech.wcomponents.WText;
import com.github.bordertech.wcomponents.WTextField;

/**
 * 
 * This example demonstrates usage of access keys with the {@link WButton} and {@link WLabel} components.
 * 
 * 
 * The contained examples include:
 * 
 * 
 * Labels, links and buttons can be assigned an access key.
 * Labels, links and buttons will highlight the access key character in the label/link/button text.
 * The first matching character in the label/link/button text is highlighted to indicate the access key.
 * If no title is set on component the label/link/button title will be the access key combination.
 * 
 *
 * @author Christina Harris
 * @since 15/04/2009
 */
public class AccessKeyExample extends WContainer {

	/**
	 * Creates an AccessKeyExample.
	 */
	public AccessKeyExample() {
		// A button with access key, default highlighted character.

		WText text = new WText(
				"A button with accesskey 'a', the default accesskey title are used.");
		text.setEncodeText(false);
		add(text);

		WButton button = new WButton("Save As", 'a');
		add(button);

		// A link with access key, override default highlighted character.
		add(new WHorizontalRule());
		text = new WText(
				"A link with accesskey 'e'. No title is set so the accesskey title is used.");
		text.setEncodeText(false);
		add(text);

		WLink link = new WLink("Example", "http://www.example.com");
		link.setAccessKey('p');
		link.setOpenNewWindow(false);
		add(link);

		// A checkbox with access key.
		add(new WHorizontalRule());
		text = new WText(
				"A checkbox with accesskey 'b'. Default accesskey index. No title is set so the accesskey title will be used.");
		text.setEncodeText(false);
		add(text);

		WCheckBox checkBox = new WCheckBox();
		WLabel checkBoxLabel = new WLabel("Check box", checkBox);
		checkBoxLabel.setAccessKey('b');
		add(checkBoxLabel);
		add(checkBox);

		// A radio button label with access key
		add(new WHorizontalRule());
		text = new WText(
				"A radio button label with accesskey 'x'. The accesskey is not in the labels text so no character is highlighted. A title is set so the accesskey title will not be used.

");
		text.setEncodeText(false);
		add(text);

		RadioButtonGroup group = new RadioButtonGroup();
		add(group);
		WRadioButton radioButton = group.addRadioButton(1);
		WLabel radioButtonLabel = new WLabel("Radio Button", 'x', radioButton);
		radioButtonLabel.setToolTip("My tool tip");
		add(radioButtonLabel);
		add(radioButton);

		// A text field with access key, no access key highlight.
		add(new WHorizontalRule());
		text = new WText(
				"A text input label with accesskey 'f'. No title is set so the accesskey title will be used.

");
		text.setEncodeText(false);
		add(text);

		WTextField textField = new WTextField();
		WLabel textFieldLabel = new WLabel("Text Field", 'f', textField);
		add(textFieldLabel);
		add(textField);

		// A dropdown field label with an accesskey.
		add(new WHorizontalRule());
		text = new WText(
				"A dropdown label with accesskey 'o'. A title is set so this will be used.

");
		text.setEncodeText(false);
		add(text);

		WDropdown dropdown = new WDropdown(
				new String[]{"Monday", "Tuesday", "Wednesday", "Thursday"});
		WLabel dropdownLabel = new WLabel("Dropdown", 'o', dropdown);
		add(dropdownLabel);
		add(dropdown);

		// access keys for multiple input components
		add(new WHorizontalRule());
		WFieldLayout layout = new WFieldLayout(WFieldLayout.LAYOUT_STACKED);
		add(layout);
		String[] options = new String[]{"Dog", "Cat", "Bird", "Turtle"};
		final WCheckBoxSelect select = new WCheckBoxSelect(options);
		select.setFrameless(true);
		WLabel label = new WLabel("Select some animals");
		label.setAccessKey('O');
		layout.addField(label, select);
		WRadioButtonSelect rbs = new WRadioButtonSelect(options);
		rbs.setFrameless(true);
		label = new WLabel("Select an animal");
		label.setAccessKey('A');
		layout.addField(label, rbs);
		label = new WLabel("Select some animals");
		label.setAccessKey('L');
		layout.addField(label, new WMultiSelectPair(options));
		label = new WLabel("Select some animals");
		label.setAccessKey('M');
		layout.addField(label, new WMultiDropdown(options));
	}
}