votorola.g.web.gwt

Class Switch

java.lang.Object

Switch

All Implemented Interfaces:

ValueChangeHandler<String>, EventHandler, Hold

public class Switch
extends Object
implements Hold, ValueChangeHandler<String>

A URL fragment variable for controlling the navigable state of the application. The format is similar to that of a query parameter. Switch names are documented and reserved on a per application basis. See Scenes for an example.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	lastValue
protected Spool	spool
static RegExp	SWITCH_SPEC_PATTERN The pattern of a switch specification.
static RegExp	SWITCH_SPEC_SEPARATOR_PATTERN The pattern of a switch specification separator.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Switch(String _name, HistoryX _history) Constructs a Switch and initializes it.
protected	Switch(String _name, HistoryX _history, boolean toInit) Constructs a Switch.

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addHandler(ValueChangeHandler<String> handler) Registers a handler to receive change events fired by this switch.
String	clear() Removes this switch from the URL and returns its value.
String	get() Returns the value of this switch, or null if it has no value.
HistoryX	history() The history stack.
String	name() The unique name of this switch.
void	onValueChange(ValueChangeEvent<String> e) Handles changes to the overall fragment.
void	release() Releases this hold.
String	set(String value) Sets the value of this switch and returns the old value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SWITCH_SPEC_PATTERN

public static final RegExp SWITCH_SPEC_PATTERN

The pattern of a switch specification. The form is nearly identical to that of an HTTP query parameter specification: NAME=VALUE. A match sets the name and value to groups 1 and 2.

Like in the value of a query parameter, actual spaces ' ' in the switch value are encoded as plus signs '+' in the formal URL. Unlike in a query parameter, actual plus signs are encoded as escaped spaces (%20), not plus signs (%2B). This is the only difference between the two.

SWITCH_SPEC_SEPARATOR_PATTERN

public static final RegExp SWITCH_SPEC_SEPARATOR_PATTERN

The pattern of a switch specification separator. As in HTTP query parameters, multiple specifications are separated by ampersand characters (&).

lastValue

protected String lastValue

spool

protected Spool spool

Constructor Detail

Switch

public Switch(String _name,
      HistoryX _history)

Constructs a Switch and initializes it. Call release() if you are finished with it prior to releasing the provided history stack.

See Also:

name(), history()

Switch

protected Switch(String _name,
      HistoryX _history,
      boolean toInit)

Constructs a Switch. Call release() if you are finished with it prior to releasing the provided history stack.

Parameters:

toInit - whether to initialize the newly constructed instance. Subclasses may use this to defer initialization so they can use their overridden versions of the init methods.

See Also:

name(), history()

Method Detail

addHandler

public final HandlerRegistration addHandler(ValueChangeHandler<String> handler)

Registers a handler to receive change events fired by this switch. These are similar to the change events of the history stack, only more specific. Both types of event are fired only after all switches have been updated with their new values.

See Also:

HistoryX.addHandler(ValueChangeHandler)

clear

public final String clear()

Removes this switch from the URL and returns its value.

See Also:

HistoryX.clearSwitchValue(String)

get

public final String get()

Returns the value of this switch, or null if it has no value.

See Also:

HistoryX.getSwitchValue(String)

history

public final HistoryX history()

The history stack.

name

public final String name()

The unique name of this switch.

set

public final String set(String value)

Sets the value of this switch and returns the old value. Setting an empty value has the same effect as clearing the switch.

See Also:

HistoryX.setSwitchValue(String,String)

release

public final void release()

Description copied from interface: Hold

Releases this hold.

Specified by:

release in interface Hold

onValueChange

public final void onValueChange(ValueChangeEvent<String> e)

Handles changes to the overall fragment.

Specified by:

onValueChange in interface ValueChangeHandler<String>