com.wewebu.ow.server.ui

Class OwKeyEvent

java.lang.Object

com.wewebu.ow.server.ui.OwKeyEvent

All Implemented Interfaces:

OwEventDescription

public class OwKeyEvent
extends Object
implements OwEventDescription

OwKeyEvent.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Constructor Summary

Constructors

Constructor and Description
OwKeyEvent(int iKeyCode_p, int iCtrlKey_p, String strEventURL_p, String strFormName_p, String description_p) create key event

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj_p)
static String	getCtrlDescription(Locale locale_p, int iCtrlCode_p) Deprecated. since 4.1.1.0 use OwKeyboardDescription
int	getCtrlKeyCode()
String	getDescription()
String	getDescription(Locale locale, OwOSFamily userAgentFamily)
String	getEventString(Locale locale, OwOSFamily userAgentFamily)
String	getEventURL()
String	getFormName()
int	getKeyCode()
String	getKeyDescription(Locale locale_p) Deprecated. since 4.1.1.0 use getKeyDescription(Locale, OwOSFamily)
String	getKeyDescription(Locale locale, OwOSFamily userAgentFamily)
int	getMaskedCode() compute a code from keycode and CTRL code
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

OwKeyEvent

public OwKeyEvent(int iKeyCode_p,
          int iCtrlKey_p,
          String strEventURL_p,
          String strFormName_p,
          String description_p)

create key event

Parameters:

iKeyCode_p - int code of the keyboard key as returned by the JavaScript method event.keyCode

iCtrlKey_p - int any combination of the KEYBOARD_CTRLKEY_... definitions, can be 0

strEventURL_p - String URL to be requested upon key press

strFormName_p - String form name

description_p - String description of the event

Method Detail

getKeyCode

public int getKeyCode()

getCtrlKeyCode

public int getCtrlKeyCode()

getEventURL

public String getEventURL()

getFormName

public String getFormName()

getDescription

public String getDescription()

getCtrlDescription

public static String getCtrlDescription(Locale locale_p,
                        int iCtrlCode_p)

Deprecated. since 4.1.1.0 use OwKeyboardDescription

Parameters:

locale_p -

Returns:

a ctrl-key description based on the given locale and unknown user agent

getKeyDescription

public String getKeyDescription(Locale locale,
                       OwOSFamily userAgentFamily)

Parameters:

locale -

userAgentFamily -

Returns:

key event triggering key combination description based on the given locale and user agent OS family

Since:

4.1.1.0

getEventString

public String getEventString(Locale locale,
                    OwOSFamily userAgentFamily)

Specified by:

getEventString in interface OwEventDescription

getKeyDescription

public String getKeyDescription(Locale locale_p)

Deprecated. since 4.1.1.0 use getKeyDescription(Locale, OwOSFamily)

Parameters:

locale_p -

Returns:

key description based on the given locale and unknown user agent

getMaskedCode

public int getMaskedCode()

compute a code from keycode and CTRL code

Returns:

int

equals

public boolean equals(Object obj_p)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDescription

public String getDescription(Locale locale,
                    OwOSFamily userAgentFamily)

Specified by:

getDescription in interface OwEventDescription