|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.wewebu.ow.server.history.OwTouchConfiguration
public class OwTouchConfiguration
Class for holding the configuration information for in session History entries, and for the Touch plugin.
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
Nested Class Summary | |
---|---|
class |
OwTouchConfiguration.OwEventID2IconMaping
Convenient class for holding a pair of event ID and icon for a given event type |
Field Summary | |
---|---|
static String |
ALL_EVENT_IDS
all event IDs, corresponding to "*" from XML configuration eventId |
static int |
ALL_EVENT_TYPES
all event types, corresponding with "*" from XML configuration event type |
static int |
NOT_DEFINED
constant for not defined event type |
Constructor Summary | |
---|---|
OwTouchConfiguration(boolean shouldReadIcons_p)
Constructor |
|
OwTouchConfiguration(boolean shouldReadIcons_p,
Node touchConfigurationNode_p,
Locale locale_p)
Constructor |
Method Summary | |
---|---|
Set |
getConfiguredEventTypes()
Return the configured event types. |
List |
getConfiguredMappingForEventType(int eventType_p)
Return a list of mappings for the given event type |
String[] |
getEventIdsForEventType(int eventType_p)
Get configured event IDs for the given eventType. |
String |
getIconForEventType(int eventType_p,
String eventId_p)
Get the icon path for a given pair of eventType and event ID |
void |
init(Node touchConfigurationNode_p,
Locale locale_p)
Initialize this configuration element. |
boolean |
isConfigured(int eventType_p)
Check if the given event type is configured. |
boolean |
isConfigured(int eventType_p,
String strEventID_p)
Check if a pair of event type and event ID is configured in XML. |
boolean |
isGenericEventId(String eventId_p)
Check if the given event ID is a generic one. |
boolean |
isGenericEventType(Integer eventType_p)
Check if the given event type is a generic event type |
boolean |
isTouchConfigurationInitialized()
Check if this configuration was correctly initialized. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ALL_EVENT_TYPES
public static final String ALL_EVENT_IDS
public static final int NOT_DEFINED
Constructor Detail |
---|
public OwTouchConfiguration(boolean shouldReadIcons_p)
shouldReadIcons_p
- - flag used to read or not the icon path from configuration.public OwTouchConfiguration(boolean shouldReadIcons_p, Node touchConfigurationNode_p, Locale locale_p) throws OwConfigurationException
shouldReadIcons_p
- - flag used to read or not the icon path from configuration.touchConfigurationNode_p
- - the XML node (SessionEvents|TouchEvents)
OwConfigurationException
- thrown when the configuration is not valid.Method Detail |
---|
public void init(Node touchConfigurationNode_p, Locale locale_p) throws OwConfigurationException
touchConfigurationNode_p
- - the XML node (SessionEvents|TouchEvents)locale_p
- - the m_locale object
OwConfigurationException
- thrown when the configuration is not valid.public String getIconForEventType(int eventType_p, String eventId_p)
eventType_p
- - the event typeeventId_p
- - the event ID.
public String[] getEventIdsForEventType(int eventType_p)
eventType_p
- - the event type
public boolean isConfigured(int eventType_p, String strEventID_p)
eventType_p
- - the event typestrEventID_p
- - the event ID
true
- if the pair is configured in the XML.public boolean isConfigured(int eventType_p)
eventType_p
- - the event type
true
- if the given type is configured.public Set getConfiguredEventTypes()
public List getConfiguredMappingForEventType(int eventType_p)
eventType_p
- - the event type
public boolean isTouchConfigurationInitialized()
true
if configuration was correctly initialized.public boolean isGenericEventType(Integer eventType_p)
eventType_p
-
public boolean isGenericEventId(String eventId_p)
eventId_p
- - the event ID.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |