Amber Demonstration API Documentation: Class RConstants

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

amber.client
Class RConstants

java.lang.Object
  |
  +--amber.client.RConstants

public class RConstants
extends java.lang.Object

This is a class which holds constants for the base systems. It is placed in a separate class as it is then not deployed with the normal deployment, thereby reducing download size.

Version:: 1.0.0
Author:: Dr. David J. Knowles
See Also:: BaseComponent, BaseControl

Field Summary

static byte ActionEventId
          This is the packet command ID for the corresponding event message.

static int ActionEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ActionEventMask
          This is the actual bit image for the mask corresponding to the event.

static int AdminPort
          The port on which to communicate with the server when using the admin interface.

static int Application
          This is an identifier which describes the type of connecting system.

static byte AvailableHandlers
          This command is used by the server to give all the possible matching ApplicationHandlers available.

static int Browser
          This is an identifier which describes the type of connecting system.

static java.lang.String ClientSocketClassName
          Secure client socket constant used when instantiating the socket using reflection.

static java.lang.String ClientSocketConnectFunction


static byte ComponentHiddenEventId
          This is the packet command ID for the corresponding event message.

static int ComponentHiddenEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ComponentHiddenEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte ComponentMovedEventId
          This is the packet command ID for the corresponding event message.

static int ComponentMovedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ComponentMovedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte ComponentResizedEventId
          This is the packet command ID for the corresponding event message.

static int ComponentResizedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ComponentResizedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte ComponentShownEventId
          This is the packet command ID for the corresponding event message.

static int ComponentShownEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ComponentShownEventMask
          This is the actual bit image for the mask corresponding to the event.

static java.lang.String DefaultConnectionModuleClass
          The default connection module to use when connecting to the remote server.

static int DeviceManager
          This is an identifier which describes the type of connecting system.

static byte DisplayMessage
          This command displays a message box with the specified title and message.

static byte DoNothing
          This command is a placeholder and will do nothing.

static java.lang.String[] EventNames
          This string array is the human readable version of the event masks.

static java.lang.String[] EventStrings
          List of all EventMask constants in a String form.

static byte ExtensionCommandBaseId
          This is the base value for extension commands.

static byte FocusGainedEventId
          This is the packet command ID for the corresponding event message.

static int FocusGainedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int FocusGainedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte FocusLostEventId
          This is the packet command ID for the corresponding event message.

static int FocusLostEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int FocusLostEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte GetMetrics
          This command returns the font metric characteristics for the specified information.

static byte GetMetricsResponse
          This response is the response to the GetMetrics command.

static byte GetSize
          This command returns the size of the component.

static byte GetSizeResponse
          This command is the return value for the query component size.

static int IntegerItem
          Type of item in an item event.

static int InvalidPageId
          The PageID value which is not used.

static int InvalidPageSubId
          The SubID value which is not used.

static byte ItemEventId
          This is the packet command ID for the corresponding event message.

static int ItemEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int ItemEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte KeyPressedEventId
          This is the packet command ID for the corresponding event message.

static int KeyPressedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int KeyPressedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte KeyReleasedEventId
          This is the packet command ID for the corresponding event message.

static int KeyReleasedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int KeyReleasedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte KeyTypedEventId
          This is the packet command ID for the corresponding event message.

static int KeyTypedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int KeyTypedEventMask
          This is the actual bit image for the mask corresponding to the event.

static short MasterAppletId
          The ID of the applet the owns the transmit/receive functionality

static byte MouseClickedEventId
          This is the packet command ID for the corresponding event message.

static int MouseClickedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseClickedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MouseDraggedEventId
          This is the packet command ID for the corresponding event message.

static int MouseDraggedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseDraggedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MouseEnteredEventId
          This is the packet command ID for the corresponding event message.

static int MouseEnteredEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseEnteredEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MouseExitedEventId
          This is the packet command ID for the corresponding event message.

static int MouseExitedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseExitedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MouseMovedEventId
          This is the packet command ID for the corresponding event message.

static int MouseMovedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseMovedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MousePressedEventId
          This is the packet command ID for the corresponding event message.

static int MousePressedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MousePressedEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte MouseReleasedEventId
          This is the packet command ID for the corresponding event message.

static int MouseReleasedEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int MouseReleasedEventMask
          This is the actual bit image for the mask corresponding to the event.

static int NumberOfEvents
          This is the mask ID which is used to enable the corresponding events.

static int Port
          The port on which to communicate with the server

static int QueryApplications
          This constants defines one possible states of the initial connection packet.

static byte QueryMessage
          This command creates a query message box which requests user input.

static byte QueryMessageResponse
          This is the response message to the query message command.

static long QueryTimeout
          The event timeout for the queryDisplayMessageBox.

static byte Reconnect
          This command is sent to the server when the master component re-attempts to connect to the server when the connection fails.

static byte RequestFocus
          This command requests that this control gain focus.

static byte RequestUrl
          This command gets the component to request a specified URL.

static int SecurePort
          The port on which to communicate with the server using the secure protocol.

static byte SessionInit
          This command is used by the server to initialise the master applet with initial session information.

static int SetBackground
          For the SetForegroundBackground command this value defines what values will be set.

static int SetBoth
          For the SetForegroundBackground command this value defines what values will be set.

static byte SetCursor
          This command sets the cursor to be used.

static byte SetEnabled
          This command enables the control.

static byte SetEventMask
          This command sets the event mask which the component responds to.

static byte SetFont
          This command sets the font to be used by the component.

static byte SetForeBackColours
          This command sets the foreground and background colours for the component.

static int SetForeground
          For the SetForegroundBackground command this value defines what values will be set.

static int SetLocation
          For the SetBounds command in RContainer this value defines what characteristics of the component will be set.

static int SetLocationAndSize
          For the SetBounds command in RContainer this value defines what characteristics of the component will be set.

static byte SetPageId
          This command is sent to the server when the master component initialises.

static int SetSize
          For the SetBounds command in RContainer this value defines what characteristics of the component will be set.

static byte SetVisible
          This command sets the component to be visible.

static byte ShutDown
          This command is used by the server to shut down the client system cleanly.

static int StringItem


static byte TextEventId
          This is the packet command ID for the corresponding event message.

static int TextEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int TextEventMask
          This is the actual bit image for the mask corresponding to the event.

static byte UploadRequest
          This command is an initial request for the server to transmit any new files required by the client to operate correctly.

static byte WindowEventId
          This is the packet command ID for the corresponding event message.

static int WindowEventIndex
          This is the mask ID which is used to enable the corresponding events.

static int WindowEventMask
          This is the actual bit image for the mask corresponding to the event.

Methods inherited from class java.lang.Object

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

Field Detail

DoNothing

public static final byte DoNothing

This command is a placeholder and will do nothing.

SetPageId

public static final byte SetPageId

This command is sent to the server when the master component initialises.

Reconnect

public static final byte Reconnect

This command is sent to the server when the master component re-attempts to connect to the server when the connection fails.

UploadRequest

public static final byte UploadRequest

This command is an initial request for the server to transmit any new files required by the client to operate correctly.

RequestUrl

public static final byte RequestUrl

This command gets the component to request a specified URL.

SetEnabled

public static final byte SetEnabled

This command enables the control.

SetVisible

public static final byte SetVisible

This command sets the component to be visible.

DisplayMessage

public static final byte DisplayMessage

This command displays a message box with the specified title and message.

SetForeBackColours

public static final byte SetForeBackColours

This command sets the foreground and background colours for the component.

SetFont

public static final byte SetFont

This command sets the font to be used by the component.

SetCursor

public static final byte SetCursor

This command sets the cursor to be used.

QueryMessage

public static final byte QueryMessage

This command creates a query message box which requests user input.

QueryMessageResponse

public static final byte QueryMessageResponse

This is the response message to the query message command.

SetEventMask

public static final byte SetEventMask

This command sets the event mask which the component responds to.

RequestFocus

public static final byte RequestFocus

This command requests that this control gain focus. Not very meaningful for anything but panel controls.

SessionInit

public static final byte SessionInit

This command is used by the server to initialise the master applet with initial session information.

AvailableHandlers

public static final byte AvailableHandlers

This command is used by the server to give all the possible matching ApplicationHandlers available.

ShutDown

public static final byte ShutDown

This command is used by the server to shut down the client system cleanly.

GetSize

public static final byte GetSize

This command returns the size of the component.

GetSizeResponse

public static final byte GetSizeResponse

This command is the return value for the query component size.

GetMetrics

public static final byte GetMetrics

This command returns the font metric characteristics for the specified information. Data in command is:
(String text), (int font size, int font attributes, (String font name))
If no font is specified the current font for the control is assumed.

GetMetricsResponse

public static final byte GetMetricsResponse

This response is the response to the GetMetrics command. The information returned is:
(int maxAscent, int maxDescent, int leading, int maxAdvance, (int stringWidth))
If there is no font then no information will be returned