oracle.jdeveloper.webapp.designer
Class DeviceRegistry

java.lang.Object
  oracle.jdeveloper.webapp.designer.DeviceRegistry

public class DeviceRegistry
extends java.lang.Object

Device class is determened based on the model, while reference device for that device class is savet in the DTCache.

Nested Class Summary

static class

DeviceRegistry.Callback

Field Summary

static java.lang.String	DEVICE_CLASS_PROP_NAME
static java.lang.Object	KEY_CUSTOMIZE_DEVICE_LIST_ACTION Action to invoke to customize list of devices.
static java.lang.Object	KEY_DEVICE_CALLBACK If the callback is not specified for the device, it is assumed that the device is available for any web-app designer its class is available for.
static java.lang.Object	KEY_DEVICE_CLASS_CALLBACK If the callback is not specified for the device class, it is assumed that device class is available for any web-app designer.
static java.lang.Object	KEY_DEVICE_CLASS_DEVICE_COMPARATOR Comparator used to order device names belonging to a device class.
static java.lang.Object	KEY_DEVICE_CLASS_ICON Icon representing the device class.
static java.lang.Object	KEY_DEVICE_CLASS_ICON_KEY Key into a resource bundle for the icon representing device class.
static java.lang.Object	KEY_DEVICE_CLASS_NAME Display name of the device class.
static java.lang.Object	KEY_DEVICE_CLASS_RESOURCE_BUNDLE Resource bundle for device class.
static java.lang.Object	KEY_DEVICE_CLASS_SHORT_DESCRIPTION Short descritpion of the device class.
static java.lang.Object	KEY_DEVICE_NAME Display name of the device.
static java.lang.Object	KEY_DEVICE_SIZE Size of the deveice, if it has fixed dimensions.
static java.lang.Object	KEY_DEVICE_STYLE_SHEET User agent style sheet for the device.
static java.lang.Object	KEY_DEVICE_USER_AGENT User agent value of the device.
static java.lang.Object	KEY_NO_DEVICE_LABEL Label to display when no device is chosen.
static java.lang.Object	KEY_PREFERRED_DEVICE Boolean value property marking the device as preferred in its class.
static java.lang.String	REFERENCE_DEVICE_PROP_NAME Map of device properties.
static java.lang.String	REFERENCE_DEVICE_PROPERTIES_PROP_NAME

Method Summary

void	addDeviceClass(java.lang.Object deviceClassID, java.util.Map deviceClassProperties)
void	addPropertyChangeListener(java.beans.PropertyChangeListener pcl)
void	addReferenceDevice(java.lang.Object deviceClassID, java.util.Map deviceProperties) Registeres new reference device for the device category.
void	addReferenceDevice(java.lang.Object deviceClassID, java.lang.String deviceName) Registeres new reference device for the device category.
java.lang.Object	findDeviceClassID(java.lang.String deviceClassName)
java.util.Map	getDeviceClassProperties(java.lang.Object deviceClassID)
java.util.Collection<java.lang.Object>	getKnownDeviceClasses() Returns collection of the registered device class IDs.
java.util.Collection<java.lang.String>	getKnownReferenceDevices(java.lang.Object deviceClassID) Returns list of names for reference devices that are registered for the given device class.
java.lang.String	getReferenceDeviceName(Context context) Returns name of selected reference device given by the context.
java.lang.String	getReferenceDeviceName(Context context, java.lang.Object deviceClassID) Returns name of selected reference device given by the context.
java.lang.String	getReferenceDeviceName(Context context, java.lang.String deviceClassName)
java.util.Map	getReferenceDeviceProperties(java.lang.Object deviceClassID, java.lang.String deviceName)
static DeviceRegistry	getRegistry()
boolean	isReferenceDeviceNameSet(Context context)
void	removePropertyChangeListener(java.beans.PropertyChangeListener pcl)
void	removeReferenceDevice(java.lang.Object deviceClassID, java.lang.String deviceName) Removed reference device for the device category.
void	removeReferenceDeviceProperty(java.lang.Object deviceClassID, java.lang.String deviceName, java.lang.Object propertyKey) Device display name can not removed.
void	setReferenceDeviceName(Context context, java.lang.String name) Sets name of selected reference device for the node given by the context.
void	setReferenceDeviceProperty(java.lang.Object deviceClassID, java.lang.String deviceName, java.lang.Object propertyKey, java.lang.Object propertyValue) Device display name can not changed.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_DEVICE_CLASS_NAME

public static final java.lang.Object KEY_DEVICE_CLASS_NAME

Display name of the device class.

KEY_DEVICE_CLASS_RESOURCE_BUNDLE

public static final java.lang.Object KEY_DEVICE_CLASS_RESOURCE_BUNDLE

Resource bundle for device class. Type of data is ArrayResourceBundle.

See Also:

ArrayResourceBundle

KEY_DEVICE_CLASS_ICON_KEY

public static final java.lang.Object KEY_DEVICE_CLASS_ICON_KEY

Key into a resource bundle for the icon representing device class. Type of data is Integer.

KEY_DEVICE_CLASS_ICON

public static final java.lang.Object KEY_DEVICE_CLASS_ICON

Icon representing the device class. Type of data is Icon.

KEY_DEVICE_CLASS_SHORT_DESCRIPTION

public static final java.lang.Object KEY_DEVICE_CLASS_SHORT_DESCRIPTION

Short descritpion of the device class. Used as a tool tip for the device class icon. Type of data is String.

KEY_DEVICE_CLASS_CALLBACK

public static final java.lang.Object KEY_DEVICE_CLASS_CALLBACK

If the callback is not specified for the device class, it is assumed that device class is available for any web-app designer.

KEY_DEVICE_CLASS_DEVICE_COMPARATOR

public static final java.lang.Object KEY_DEVICE_CLASS_DEVICE_COMPARATOR

Comparator used to order device names belonging to a device class. Type of data is java.util.Comparator.

KEY_DEVICE_NAME

public static final java.lang.Object KEY_DEVICE_NAME

Display name of the device.

KEY_DEVICE_USER_AGENT

public static final java.lang.Object KEY_DEVICE_USER_AGENT

User agent value of the device. Type of data is String.

KEY_DEVICE_SIZE

public static final java.lang.Object KEY_DEVICE_SIZE

Size of the deveice, if it has fixed dimensions. Type of data is java.awt.Dimension.

KEY_DEVICE_STYLE_SHEET

public static final java.lang.Object KEY_DEVICE_STYLE_SHEET

User agent style sheet for the device. Type of data is java.net.URL location of the style sheet, or java.lang.String containing the style sheet itself.

KEY_DEVICE_CALLBACK

public static final java.lang.Object KEY_DEVICE_CALLBACK

If the callback is not specified for the device, it is assumed that the device is available for any web-app designer its class is available for.

KEY_PREFERRED_DEVICE

public static final java.lang.Object KEY_PREFERRED_DEVICE

Boolean value property marking the device as preferred in its class.

KEY_NO_DEVICE_LABEL

public static final java.lang.Object KEY_NO_DEVICE_LABEL

Label to display when no device is chosen.

KEY_CUSTOMIZE_DEVICE_LIST_ACTION

public static final java.lang.Object KEY_CUSTOMIZE_DEVICE_LIST_ACTION

Action to invoke to customize list of devices.

DEVICE_CLASS_PROP_NAME

public static final java.lang.String DEVICE_CLASS_PROP_NAME

See Also:

Constant Field Values

REFERENCE_DEVICE_PROP_NAME

public static final java.lang.String REFERENCE_DEVICE_PROP_NAME

Map of device properties.

See Also:

Constant Field Values

REFERENCE_DEVICE_PROPERTIES_PROP_NAME

public static final java.lang.String REFERENCE_DEVICE_PROPERTIES_PROP_NAME

See Also:

Constant Field Values

Method Detail

getRegistry

public static DeviceRegistry getRegistry()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener pcl)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener pcl)

getKnownDeviceClasses

public java.util.Collection<java.lang.Object> getKnownDeviceClasses()

Returns collection of the registered device class IDs.

Returns:

addDeviceClass

public void addDeviceClass(java.lang.Object deviceClassID,
                           java.util.Map deviceClassProperties)

getDeviceClassProperties

public java.util.Map getDeviceClassProperties(java.lang.Object deviceClassID)

findDeviceClassID

public java.lang.Object findDeviceClassID(java.lang.String deviceClassName)

addReferenceDevice

public void addReferenceDevice(java.lang.Object deviceClassID,
                               java.lang.String deviceName)

Registeres new reference device for the device category.

Parameters:

deviceClassID -

deviceName -

removeReferenceDevice

public void removeReferenceDevice(java.lang.Object deviceClassID,
                                  java.lang.String deviceName)

Removed reference device for the device category.

Parameters:

deviceClassID -

deviceName -

addReferenceDevice

public void addReferenceDevice(java.lang.Object deviceClassID,
                               java.util.Map deviceProperties)

Registeres new reference device for the device category. Device properties has to have at least display name set.

Parameters:

deviceClassID -

deviceProperties -

getReferenceDeviceProperties

public java.util.Map getReferenceDeviceProperties(java.lang.Object deviceClassID,
                                                  java.lang.String deviceName)

setReferenceDeviceProperty

public void setReferenceDeviceProperty(java.lang.Object deviceClassID,
                                       java.lang.String deviceName,
                                       java.lang.Object propertyKey,
                                       java.lang.Object propertyValue)

Device display name can not changed.

Parameters:

deviceClassID -

deviceName -

propertyKey -

propertyValue -

removeReferenceDeviceProperty

public void removeReferenceDeviceProperty(java.lang.Object deviceClassID,
                                          java.lang.String deviceName,
                                          java.lang.Object propertyKey)

Device display name can not removed.

Parameters:

deviceClassID -

deviceName -

propertyKey -

getKnownReferenceDevices

public java.util.Collection<java.lang.String> getKnownReferenceDevices(java.lang.Object deviceClassID)

Returns list of names for reference devices that are registered for the given device class. Returned list is ordered using device class comparator, if one exists, otherwise String.CASE_INSENSITIVE_ORDER is used.

Parameters:

deviceClassID -

Returns:

getReferenceDeviceName

public java.lang.String getReferenceDeviceName(Context context)

Returns name of selected reference device given by the context. Returns null if context is invalid or the reference device is not yet set.

Parameters:

context -

Returns:

getReferenceDeviceName

public java.lang.String getReferenceDeviceName(Context context,
                                               java.lang.String deviceClassName)

Parameters:

context -

deviceClassName -

Returns:

See Also:

getReferenceDeviceName(Context, Object)

isReferenceDeviceNameSet

public boolean isReferenceDeviceNameSet(Context context)

getReferenceDeviceName

public java.lang.String getReferenceDeviceName(Context context,
                                               java.lang.Object deviceClassID)

Returns name of selected reference device given by the context. Returns default reference device for the device class if it is not yet set. Returns null if context is invalid or the reference device is not yet set. Also, this method will verify that set reference device belongs to the given category.

Parameters:

context -

deviceClassID -

Returns:

setReferenceDeviceName

public void setReferenceDeviceName(Context context,
                                   java.lang.String name)

Sets name of selected reference device for the node given by the context.

Parameters:

context -

name - null value removes reference device name