org.eclipse.rwt.lifecycle
Class ControlLCAUtil

java.lang.Object
  org.eclipse.rwt.lifecycle.ControlLCAUtil

public class ControlLCAUtil
extends java.lang.Object

Utility class that provides a number of useful static methods to support the implementation of life cycle adapters (LCAs) for Controls.

Since:

1.0

See Also:

WidgetLCAUtil

Method Summary

static int	getZIndex(Control control) Deprecated. This method should not be used anymore.
static void	preserveBackgroundImage(Control control) Preserves the value of the specified widget's background image.
static void	preserveMenuDetectListener(Control control) Deprecated. Use WidgetLCAUtil.preserveListener(Widget, String, boolean) instead
static void	preserveValues(Control control) Preserves the values of the following properties of the specified control: bounds z-index (except for Shells) tab index tool tip text menu visible enabled foreground background background image font cursor whether ControlListeners are registered whether ActivateListeners are registered whether MouseListeners are registered whether FocusListeners are registered whether KeyListeners are registered whether TraverseListeners are registered whether HelpListeners are registered whether MenuDetectListeners are registered
static void	processKeyEvents(Control control)
static void	processMenuDetect(Control control) Process a HelpEvent if the current request specifies that there occured a help event for the given widget.
static void	processMouseEvents(Control control)
static void	processSelection(Widget widget, Item item, boolean readBounds)
static void	readBounds(Control control) Reads the bounds of the specified control from the current request and applies it to the control.
static void	renderBackground(Control control) Determines whether the property background of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side background property.
static void	renderBackgroundImage(Control control) Determines whether the background image of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side background image property.
static void	renderBounds(Control control) Determines whether the bounds of the given control have changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side bounds.
static void	renderChanges(Control control) Determines for all of the following properties of the specified control whether the property has changed during the processing of the current request and if so, writes a protocol message to the response that updates the corresponding client-side property.
static void	renderEnabled(Control control) Determines whether the property enabled of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side enabled property.
static void	renderFont(Control control) Determines whether the property font of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side font property.
static void	renderForeground(Control control) Determines whether the property foreground of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side foreground property.
static void	renderMenu(Control control) Determines whether the property menu of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side menu property.
static void	renderToolTip(Control control) Determines whether the tool tip of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side tool tip.
static void	renderVisible(Control control) Determines whether the visibility of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side visibility.
static void	writeActivateListener(Control control) Deprecated. Use renderListenActivate(Control) instead
static void	writeBackground(Control control) Deprecated. Use renderBackground(Control) instead
static void	writeBackgroundImage(Control control) Deprecated. Use renderBackgroundImage(Control) instead
static void	writeBounds(Control control) Deprecated. Use renderBounds(Control) instead
static void	writeChanges(Control control) Deprecated. Use renderChanges(Control)
static void	writeEnabled(Control control) Deprecated. Use renderEnabled(Control) instead
static void	writeFont(Control control) Deprecated. Use renderFont(Control) instead
static void	writeForeground(Control control) Deprecated. Use renderForeground(Control) instead
static void	writeMenu(Control control) Deprecated. Use renderMenu(Control) instead
static void	writeMenuDetectListener(Control control) Deprecated. Use renderListenMenuDetect(Control) instead
static void	writeStyleFlags(Control control) Deprecated. Use WidgetLCAUtil.getStyles(Widget, String[]) to obtain the list of styles instead and set the result to the property style
static void	writeToolTip(Control control) Deprecated. Use renderToolTip(Control) instead
static void	writeVisible(Control control) Deprecated. Use renderVisible(Control) instead
static void	writeZIndex(Control control) Deprecated. This method should not be used anymore as zIndex is not rendered directly anymore.

Methods inherited from class java.lang.Object

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

Method Detail

readBounds

public static void readBounds(Control control)

Reads the bounds of the specified control from the current request and applies it to the control. If no bounds are not submitted for the control, it remains unchanged.

Parameters:

control - the control whose bounds to read and set

processMenuDetect

public static void processMenuDetect(Control control)

Process a HelpEvent if the current request specifies that there occured a help event for the given widget.

Parameters:

control - the control to process

Since:

1.3

processMouseEvents

public static void processMouseEvents(Control control)

processKeyEvents

public static void processKeyEvents(Control control)

processSelection

public static void processSelection(Widget widget,
                                    Item item,
                                    boolean readBounds)

preserveValues

public static void preserveValues(Control control)

Preserves the values of the following properties of the specified control:

• bounds
• z-index (except for Shells)
• tab index
• tool tip text
• menu
• visible
• enabled
• foreground
• background
• background image
• font
• cursor
• whether ControlListeners are registered
• whether ActivateListeners are registered
• whether MouseListeners are registered
• whether FocusListeners are registered
• whether KeyListeners are registered
• whether TraverseListeners are registered
• whether HelpListeners are registered
• whether MenuDetectListeners are registered

Parameters:

control - the control whose parameters to preserve

See Also:

writeChanges(Control)

preserveBackgroundImage

public static void preserveBackgroundImage(Control control)

Preserves the value of the specified widget's background image.

Parameters:

control - the control whose background image property to preserve

See Also:

writeBackgroundImage(Control)

renderChanges

public static void renderChanges(Control control)

Determines for all of the following properties of the specified control whether the property has changed during the processing of the current request and if so, writes a protocol message to the response that updates the corresponding client-side property.

• bounds
• z-index (except for Shells)
• tab index
• tool tip text
• menu
• visible
• enabled
• foreground
• background
• background image
• font
• cursor
• whether ActivateListeners are registered
• whether MouseListeners are registered
• whether FocusListeners are registered
• whether KeyListeners are registered
• whether TraverseListeners are registered
• whether HelpListeners are registered

Parameters:

control - the control whose properties to set

Since:

1.5

See Also:

preserveValues(Control)

renderBounds

public static void renderBounds(Control control)

Determines whether the bounds of the given control have changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side bounds.

Parameters:

control - the control whose bounds to write

Since:

1.5

renderToolTip

public static void renderToolTip(Control control)

Determines whether the tool tip of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side tool tip.

Parameters:

control - the control whose tool tip to write

Since:

1.5

renderMenu

public static void renderMenu(Control control)

Determines whether the property menu of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side menu property.

Parameters:

control - the control whose menu property to write

Since:

1.5

renderVisible

public static void renderVisible(Control control)

Determines whether the visibility of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side visibility.

Parameters:

control - the control whose visibility to write

Since:

1.5

renderEnabled

public static void renderEnabled(Control control)

Determines whether the property enabled of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side enabled property.

Parameters:

control - the control whose enabled property to write

Since:

1.5

renderForeground

public static void renderForeground(Control control)

Determines whether the property foreground of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side foreground property.

Parameters:

control - the control whose foreground property to write

Since:

1.5

renderBackground

public static void renderBackground(Control control)

Determines whether the property background of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side background property.

Parameters:

control - the control whose background property to write

Since:

1.5

renderBackgroundImage

public static void renderBackgroundImage(Control control)

Determines whether the background image of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side background image property.

Parameters:

control - the control whose background image property to write

Since:

1.5

renderFont

public static void renderFont(Control control)

Determines whether the property font of the given control has changed during the processing of the current request and if so, writes a protocol message to the response that updates the client-side font property.

Parameters:

control - the control whose font property to write

Since:

1.5

writeChanges

@Deprecated
public static void writeChanges(Control control)
                         throws java.io.IOException

Deprecated. Use renderChanges(Control)

Determines for all of the following properties of the specified control whether the property has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the corresponding client-side property.

• bounds
• z-index (except for Shells)
• tab index
• tool tip text
• menu
• visible
• enabled
• foreground
• background
• background image
• font
• cursor
• whether ActivateListeners are registered
• whether MouseListeners are registered
• whether FocusListeners are registered
• whether KeyListeners are registered
• whether TraverseListeners are registered
• whether HelpListeners are registered

Parameters:

control - the control whose properties to set

Throws:

java.io.IOException

See Also:

preserveValues(Control)

writeBounds

@Deprecated
public static void writeBounds(Control control)
                        throws java.io.IOException

Deprecated. Use renderBounds(Control) instead

Determines whether the bounds of the given control have changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side bounds.

Parameters:

control - the control whose bounds to write

Throws:

java.io.IOException

writeZIndex

@Deprecated
public static void writeZIndex(Control control)
                        throws java.io.IOException

Deprecated. This method should not be used anymore as zIndex is not rendered directly anymore.

Determines whether the z-index of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side z-index.

Parameters:

control - the control whose z-index to write

Throws:

java.io.IOException

writeToolTip

@Deprecated
public static void writeToolTip(Control control)
                         throws java.io.IOException

Deprecated. Use renderToolTip(Control) instead

Determines whether the tool tip of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side tool tip.

Parameters:

control - the control whose tool tip to write

Throws:

java.io.IOException

writeMenu

@Deprecated
public static void writeMenu(Control control)
                      throws java.io.IOException

Deprecated. Use renderMenu(Control) instead

Determines whether the property menu of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side menu property.

Parameters:

control - the control whose menu property to write

Throws:

java.io.IOException

writeVisible

@Deprecated
public static void writeVisible(Control control)
                         throws java.io.IOException

Deprecated. Use renderVisible(Control) instead

Determines whether the visibility of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side visibility.

Parameters:

control - the control whose visibility to write

Throws:

java.io.IOException

writeEnabled

@Deprecated
public static void writeEnabled(Control control)
                         throws java.io.IOException

Deprecated. Use renderEnabled(Control) instead

Determines whether the property enabled of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side enabled property.

Parameters:

control - the control whose enabled property to write

Throws:

java.io.IOException

writeForeground

@Deprecated
public static void writeForeground(Control control)
                            throws java.io.IOException

Deprecated. Use renderForeground(Control) instead

Determines whether the property foreground of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side foreground property.

Parameters:

control - the control whose foreground property to write

Throws:

java.io.IOException

writeBackground

@Deprecated
public static void writeBackground(Control control)
                            throws java.io.IOException

Deprecated. Use renderBackground(Control) instead

Determines whether the property background of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side background property.

Parameters:

control - the control whose background property to write

Throws:

java.io.IOException

writeBackgroundImage

@Deprecated
public static void writeBackgroundImage(Control control)
                                 throws java.io.IOException

Deprecated. Use renderBackgroundImage(Control) instead

Determines whether the background image of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side background image property.

Parameters:

control - the control whose background image property to write

Throws:

java.io.IOException

writeFont

@Deprecated
public static void writeFont(Control control)
                      throws java.io.IOException

Deprecated. Use renderFont(Control) instead

Determines whether the property font of the given control has changed during the processing of the current request and if so, writes JavaScript code to the response that updates the client-side font property.

Parameters:

control - the control whose font property to write

Throws:

java.io.IOException

writeActivateListener

@Deprecated
public static void writeActivateListener(Control control)
                                  throws java.io.IOException

Deprecated. Use renderListenActivate(Control) instead

Throws:

java.io.IOException

writeMenuDetectListener

@Deprecated
public static void writeMenuDetectListener(Control control)
                                    throws java.io.IOException

Deprecated. Use renderListenMenuDetect(Control) instead

Adds or removes client-side menu detect listeners for the the given control as necessary.

Parameters:

control -

Throws:

java.io.IOException

Since:

1.3

writeStyleFlags

@Deprecated
public static void writeStyleFlags(Control control)
                            throws java.io.IOException

Deprecated. Use WidgetLCAUtil.getStyles(Widget, String[]) to obtain the list of styles instead and set the result to the property style

Checks the given control for common SWT style flags (e.g. SWT.BORDER) and if present, writes code to pass the according states to the client.

Parameters:

control -

Throws:

java.io.IOException

preserveMenuDetectListener

@Deprecated
public static void preserveMenuDetectListener(Control control)

Deprecated. Use WidgetLCAUtil.preserveListener(Widget, String, boolean) instead

Preserves whether the given widget has one or more MenuDetects attached.

Parameters:

control - the widget to preserve

Since:

1.3

getZIndex

@Deprecated
public static int getZIndex(Control control)

Deprecated. This method should not be used anymore.

Determines the z-index to render for a given control.

Parameters:

control - the control whose z-index is requested

Returns:

the z-index