1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*
Copyright (C) 2000-2005 SKYRIX Software AG
This file is part of OpenGroupware.org.
OGo is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.
OGo is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.
You should have received a copy of the GNU Lesser General Public
License along with OGo; see the file COPYING. If not, write to the
Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.
*/
#ifndef __UIxComponent_H_
#define __UIxComponent_H_
#import <NGObjWeb/SoComponent.h>
#import <NGObjWeb/WOContext+SoObjects.h>
#import <SOGo/SOGoObject.h>
/*
UIxComponent
Common superclass for most components used in SOGo.
TODO: document facilities.
*/
@class NSCalendarDate, NSTimeZone, NSMutableDictionary, SoUser, SOGoUserDefaults;
@interface UIxComponent : SoComponent
{
NSMutableDictionary *queryParameters;
NSCalendarDate *_selectedDate;
NSDictionary *locale;
SOGoUserDefaults *userDefaults;
}
+ (NSArray *) monthLabelKeys;
+ (NSArray *) abbrMonthLabelKeys;
- (NSString *)queryParameterForKey:(NSString *)_key;
- (NSDictionary *)queryParameters;
/* use this to set 'sticky' query parameters */
- (void)setQueryParameter:(NSString *)_param forKey:(NSString *)_key;
/* date related query parameters */
- (NSDictionary *)queryParametersBySettingSelectedDate:(NSCalendarDate *)_date;
- (void)setSelectedDateQueryParameter:(NSCalendarDate *)_newDate
inDictionary:(NSMutableDictionary *)_qp;
/* appends queryParameters to _method if any are set */
- (NSString *)completeHrefForMethod:(NSString *)_method;
- (NSString *)ownMethodName;
- (NSString *)userFolderPath;
- (NSString *)applicationPath;
- (NSString *)modulePath;
- (NSString *)ownPath;
- (NSString *)relativePathToUserFolderSubPath:(NSString *)_sub;
/* date selection */
- (NSCalendarDate *) selectedDate;
- (NSString *) dateStringForDate: (NSCalendarDate *)_date;
- (BOOL) hideFrame;
- (UIxComponent *) jsCloseWithRefreshMethod: (NSString *) methodName;
/* SoUser */
- (NSString *) shortUserNameForDisplay;
/* labels */
- (NSString *) labelForKey:(NSString *)_key;
- (NSString *) commonLabelForKey:(NSString *)_key;
- (NSString *) labelForKey: (NSString *) _str
withResourceManager: (WOResourceManager *) _rm;
- (NSString *) localizedNameForDayOfWeek:(unsigned)_dayOfWeek;
- (NSString *) localizedAbbreviatedNameForDayOfWeek:(unsigned)_dayOfWeek;
- (NSString *) localizedNameForMonthOfYear:(unsigned)_monthOfYear;
- (NSString *) localizedAbbreviatedNameForMonthOfYear:(unsigned)_monthOfYear;
/* HTTP method safety */
- (BOOL) isInvokedBySafeMethod;
/* display the "save" button */
- (BOOL) canCreateOrModify;
/* locale */
- (NSDictionary *)locale;
/* cached resource filenames */
- (WOResourceManager *) pageResourceManager;
- (NSString *) urlForResourceFilename: (NSString *) filename;
- (WOResponse *) responseWithStatus: (unsigned int) status;
- (WOResponse *) responseWithStatus: (unsigned int) status
andString: (NSString *) contentString;
- (WOResponse *) responseWithStatus: (unsigned int) status
andJSONRepresentation: (NSObject *) contentObject;
- (WOResponse *) responseWith204;
- (WOResponse *) redirectToLocation: (NSString *) newLocation;
/* Debugging */
- (BOOL) isUIxDebugEnabled;
@end
#endif /* __UIxComponent_H_ */
|
