public final class RWT
extends java.lang.Object
UISession
,
ApplicationContext
,
ResourceManager
,
HttpServletRequest
,
HttpServletResponse
Modifier and Type | Class and Description |
---|---|
static class |
RWT.NLS
This utility class helps to provide a similar approach for compile safe
native language support than
NLS does. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTIVE_KEYS
The property to use in
Display.setData() in order to activate global key events
for certain key sequences. |
static java.lang.String |
BADGE
Controls the text shown as a badge.
|
static java.lang.String |
CANCEL_KEYS
The property to use in
Display.setData() in order to always cancel the client's
default operation associated with certain key sequences. |
static int |
CELL
Used as as detail information on a selection event to indicate that a selectable
template cell was selected instead of the widget that contains the cell.
|
static java.lang.String |
CUSTOM_ITEM_HEIGHT
The property to use in
Control.setData() in order to set a custom item height. |
static java.lang.String |
CUSTOM_VARIANT
Used to mark a widget as belonging to a custom variant in order to apply a
different theming to it.
|
static java.lang.String |
DEFAULT_THEME_ID
The ID of the default theme.
|
static java.lang.String |
FIXED_COLUMNS
Controls the number of fixed columns.
|
static int |
HYPERLINK
Used as detail information on a selection event to indicate that a hyperlink (anchor
tag) in a markup text was selected instead of the widget that contains the markup.
|
static java.lang.String |
MARKUP_ENABLED
Controls whether the use of markup in text is enabled.
|
static java.lang.String |
MNEMONIC_ACTIVATOR
The property to use in
Display.setData() in order to set the key combination for
mnemonics activation. |
static java.lang.String |
PRELOADED_ITEMS
Controls the number of preloaded items outside (above and below) visible area of virtual
Tree or Table . |
static java.lang.String |
ROW_TEMPLATE
Used to apply a row template to a control.
|
static java.lang.String |
TOOLTIP_MARKUP_ENABLED
Controls whether the use of markup in tooltip text is enabled.
|
Modifier and Type | Method and Description |
---|---|
static ApplicationContext |
getApplicationContext()
Returns the
ApplicationContext instance that represents the web context's
global data storage area. |
static Client |
getClient()
Returns a representation of the client that is connected with the server in the current UI
session.
|
static java.util.Locale |
getLocale()
Returns the preferred
Locale for the current UI session. |
static HttpServletRequest |
getRequest()
Returns the
HttpServletRequest that is currently processed. |
static ResourceManager |
getResourceManager()
Returns the instance of the resource manager for the current application context.
|
static HttpServletResponse |
getResponse()
Returns the
HttpServletResponse that will be sent to the client after processing
the current request. |
static ServiceManager |
getServiceManager()
Returns the instance of the service manager for the current application context.
|
static SettingStore |
getSettingStore()
Returns the setting store instance for the current UI session.
|
static UISession |
getUISession()
Returns the current UI session.
|
static UISession |
getUISession(Display display)
Returns the UI session that is associated with the given display.
|
static void |
requestThreadExec(java.lang.Runnable runnable)
Executes the run method of the given
runnable on the
request thread. |
static void |
setLocale(java.util.Locale locale)
Sets the preferred
Locale for the current UI session. |
public static final java.lang.String ACTIVE_KEYS
Display.setData()
in order to activate global key events
for certain key sequences. The value for this property has to be an array of Strings, each
representing a key sequence. When this property is set on the display, the client will be
instructed to issue events for the given key sequences. These key events can be captured using
Display.addFilter()
.
The property can also be used in Control.setData()
. In this case, a key listener
that is attached to that control will only receive events for the specified key sequences.
Control without active keys set will issue events for all key strokes.
Valid strings for key sequences consist of one key and any number of modifier keys,
separated by +
. Keys can be identified by their upper case character or by any
of the keywords below. Special characters (not a letter or digit) should not be combined with
any modifiers, and will issue events regardless of pressed modifiers.
The following keywords can be used to refer to special keys:
BACKSPACE
, TAB
, RETURN
,
ENTER
, ESCAPE
, SPACE
, PAGE_UP
,
PAGE_DOWN
, END
, HOME
, ARROW_LEFT
,
ARROW_UP
, ARROW_RIGHT
, ARROW_DOWN
, INSERT
,
DELETE
, F1
, F2
, F3
, F4
,
F5
, F6
, F7
, F8
, F9
,
F10
, F11
, F12
, Valid modifier keys are
SHIFT
, ALT
, and CTRL
.
"A"
, "#"
, "F12"
,
"CTRL+1"
, "ALT+ARROW_DOWN"
,
"ALT+SHIFT+X"
.
Example code for implementing a key binding:
display.setData( RWT.ACTIVE_KEYS, new String[] { "CTRL+1", "CTRL+2" } );
display.addFilter( SWT.KeyDown, new Listener() {
public void handleEvent( Event event ) {
boolean ctrlPressed = ( event.stateMask & SWT.Ctrl ) != 0;
if( ctrlPressed && event.character == '1' ) {
// handle Ctrl+1
}
}
} );
public static final java.lang.String CANCEL_KEYS
Display.setData()
in order to always cancel the client's
default operation associated with certain key sequences. It allows the same values as
ACTIVE_KEYS
. If a key sequences is given in CANCEL_KEYS
as well as
in ACTIVE_KEYS
, it will cancel its default operation, but still issue the event.
The property can also be used in Control.setData()
. In this case, the associated
default operation will only be cancelled if the control is focused.
Depending on the client, there may be certain keys that cannot be cancelled.
public static final java.lang.String MNEMONIC_ACTIVATOR
Display.setData()
in order to set the key combination for
mnemonics activation. The value for this property has to be a String.
Valid string for key sequence consist of any number of modifier keys, separated by
+
.
Mnemonics are currently supported by MenuItem
, Button
,
Label
, CLabel
, Group
, ToolItem
,
TabItem
and CTabItem
. Mnemonics are not supported on a widgets
with enabled markup.
Example code:
display.setData( RWT.MNEMONIC_ACTIVATOR, "ALT+CTRL" );
Display.setData(String,Object)
,
Constant Field Valuespublic static final java.lang.String CUSTOM_ITEM_HEIGHT
Control.setData()
in order to set a custom item height.
The custom item height must be specified as an Integer
and passed to
setData()
with this constant as the key.
For example:
table.setData( RWT.CUSTOM_ITEM_HEIGHT, Integer.valueOf( 45 ) );
Used By:
Table
Tree
List
public static final java.lang.String PRELOADED_ITEMS
Tree
or Table
. The preloaded items must be specified as an
Integer
and passed to setData()
with this constant as the key.
For example: table.setData( RWT.PRELOADED_ITEMS, Integer.valueOf( 10 ) );
Used By:
Table
Tree
Control.setData(String,Object)
,
Constant Field Valuespublic static final java.lang.String MARKUP_ENABLED
setData()
with
a value of Boolean.TRUE
. The call to setData()
must be placed directly after the control is created. Once the markup in text
is enabled it's not possible to disable it.
For example:
Table table = new Table( parent, SWT.NONE );
table.setData( RWT.MARKUP_ENABLED, Boolean.TRUE );
When markup is enabled, certain XHTML tags can be used in the text property
of the respective widget. Specifying an unsupported element will lead to an
IllegalArgumentException
when setting the text. The following table
lists the currently supported tags:
style
attribute.
Used By:
Table
Tree
Grid
List
Label
CLabel
ToolTip
Button
public static final java.lang.String TOOLTIP_MARKUP_ENABLED
setData()
with
a value of Boolean.TRUE
. The call to setData()
must be placed directly after the control is created. Once, the markup in tooltip text
is enabled it's not possible to disable it.Control.setData(String,Object)
,
MARKUP_ENABLED
,
Constant Field Valuespublic static final java.lang.String FIXED_COLUMNS
setData()
together with an Integer
object. The given number of columns, starting
with the current leftmost one, will not scroll horizontally. The call to setData()
must be placed directly after the control is created.
For example:
Table table = new Table( parent, SWT.NONE );
table.setData( RWT.FIXED_COLUMNS, Integer.valueOf( 2 ) );
Table
Tree
public static final java.lang.String BADGE
setData()
together with an String
object.
For example:
TabItem item = new TabItem( folder, SWT.NONE );
item.setData( RWT.BADGE, "23" );
TabItem
Control.setData(String,Object)
,
Constant Field Valuespublic static final java.lang.String DEFAULT_THEME_ID
public static final java.lang.String CUSTOM_VARIANT
button.setData( RWT.CUSTOM_VARIANT, "mybutton" );For more information on custom variants, see the RAP help on theming.
Widget.setData(String,Object)
,
Constant Field Valuespublic static final java.lang.String ROW_TEMPLATE
Template
. A template cell will display the content of an
item's column when its bindingIndex is set to the corresponding column index.
To apply a row template on a control, use the control's setData()
method with this
constant as key:
Template template = new Template(); // add cells to this template new TextCell(template).setBindingIndex(0).setTop(10).setLeft(20) ...; ... Table table = new Table(parent, SWT.FULL_SELECTION); // Add as many columns as needed to add multiple texts/images to items new TableColumn(); ... table.setData(RWT.ROW_TEMPLATE, template);
The call to setData()
must be placed directly after the control's creation. Once a
template is applied to a control, the control will not be affected by changes to the template.
Note that TableColumn/TreeColumn instances must be created in order to support multiple item
texts/images. If the SWT.FULL_SELECTION
style flag is not set, no selection will
be displayed.
Supported by:
Table
Tree
Grid
Control.setData(String,Object)
,
Template
,
Constant Field Valuespublic static final int HYPERLINK
a
element must have it's
target
property set to “_rwt
”.
Supported by:
Table
Tree
Grid
List
MARKUP_ENABLED
,
SelectionEvent.detail
,
Constant Field Valuespublic static final int CELL
Cell.setSelectable(boolean)
,
SelectionEvent.detail
,
Constant Field Valuespublic static ResourceManager getResourceManager()
RWT.getApplicationContext().getResourceManager()
.ApplicationContext.getResourceManager()
public static ServiceManager getServiceManager()
RWT.getApplicationContext().getServiceManager()
.ApplicationContext.getServiceManager()
public static SettingStore getSettingStore()
null
public static UISession getUISession()
null
java.lang.IllegalStateException
- when called outside of the UI threadpublic static UISession getUISession(Display display)
null
public static ApplicationContext getApplicationContext()
ApplicationContext
instance that represents the web context's
global data storage area.ApplicationContext
public static HttpServletRequest getRequest()
HttpServletRequest
that is currently processed.
Note: This method is not recommended. Typical application code should not need to call this method. Processing requests from the client is up to the framework. In rare cases, an application may be wish to access request details such as certain HTTP headers.
public static HttpServletResponse getResponse()
HttpServletResponse
that will be sent to the client after processing
the current request.
Note: This method is not recommended. Typical application code should not need to call this method. The response should only be written and modified by the framework. In rare cases, an application may wish to access the response, e.g. to add a Cookie.
public static java.util.Locale getLocale()
Locale
for the current UI session.
This method is a shortcut for RWT.getUISession().getLocale()
.Locale
for the current UI session.UISession.getLocale()
public static void setLocale(java.util.Locale locale)
Locale
for the current UI session. This method is a shortcut
for RWT.getUISession().setLocale( locale )
.locale
- the locale to set, or null
to resetUISession.setLocale(Locale)
public static void requestThreadExec(java.lang.Runnable runnable)
runnable
on the
request thread. This method may only be called from the UI thread.
NOTE: This API is provisional and may change without further notice.
runnable
- the code to be executed on the request threadjava.lang.IllegalStateException
- when called from a non-UI threadpublic static Client getClient()
RWT.getUISession().getClient()
.java.lang.IllegalStateException
- when called outside of the request context
Copyright (c) EclipseSource and others 2002, 2020.
All rights reserved. This program and the accompanying materials
are made available under the terms of the
Eclipse Public License v1.0