summaryrefslogtreecommitdiff
path: root/wizards/com/sun/star/wizards/common/PropertySetHelper.py
blob: 524caf043f362ffb1b6454063469f2c69d697195 (plain)
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# This file incorporates work covered by the following license notice:
#
#   Licensed to the Apache Software Foundation (ASF) under one or more
#   contributor license agreements. See the NOTICE file distributed
#   with this work for additional information regarding copyright
#   ownership. The ASF licenses this file to you under the Apache
#   License, Version 2.0 (the "License"); you may not use this file
#   except in compliance with the License. You may obtain a copy of
#   the License at http://www.apache.org/licenses/LICENSE-2.0 .
#
from wizards.common.DebugHelper import *
from wizards.common.DebugHelper import *

class PropertySetHelper(object):

    @classmethod
    def __init__(self, _aObj):
        self.m_xPropertySet = _aObj
        self.m_aHashMap = {}

    '''
    set a property, don't throw any exceptions,
    they will only write down as a hint in the helper debug output
    @param _sName name of the property to set
    @param _aValue property value as object
    '''

    def setPropertyValueDontThrow(self, _sName, _aValue):
        try:
            setPropertyValue(_sName, _aValue)
        except Exception, e:
            DebugHelper.writeInfo(
                "Don't throw the exception with property name(" \
                + _sName + " ) : " + e.getMessage())

    '''
    set a property,
    @param _sName name of the property to set
    @param _aValue property value as object
    @throws java.lang.Exception
    '''

    def setPropertyValue(self, _sName, _aValue):
        if self.m_xPropertySet != None:
            try:
                self.m_xPropertySet.setPropertyValue(_sName, _aValue)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
                DebugHelper.exception(e)
            except com.sun.star.beans.PropertyVetoException, e:
                DebugHelper.writeInfo(e.getMessage())
                DebugHelper.exception(e)
            except ValueError, e:
                DebugHelper.writeInfo(e.getMessage())
                DebugHelper.exception(e)
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())
                DebugHelper.exception(e)

        else:
            self.m_aHashMap[_sName] = _aValue

    '''
    get a property and convert it to a int value
    @param _sName the string name of the property
    @param _nDefault if an error occur, return this value
    @return the int value of the property
    '''

    def getPropertyValueAsInteger(self, _sName, _nDefault):
        aObject = None
        nValue = _nDefault
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        if aObject != None:
            try:
                nValue = NumericalHelper.toInt(aObject)
            except ValueError, e:
                DebugHelper.writeInfo(
                    "can't convert a object to integer.")

        return nValue

    '''
    get a property and convert it to a short value
    @param _sName the string name of the property
    @param _nDefault if an error occur, return this value
    @return the int value of the property
    '''

    def getPropertyValueAsShort(self, _sName, _nDefault):
        aObject = None
        nValue = _nDefault
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        if aObject != None:
            try:
                nValue = NumericalHelper.toShort(aObject)
            except ValueError, e:
                DebugHelper.writeInfo("can't convert a object to short.")

        return nValue

    '''
    get a property and convert it to a double value
    @param _sName the string name of the property
    @param _nDefault if an error occur, return this value
    @return the int value of the property
    '''

    def getPropertyValueAsDouble(self, _sName, _nDefault):
        aObject = None
        nValue = _nDefault
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        # TODO: I wonder why the same thing is not done in the rest of the
        # getPropertyValueAs* functions...
        if aObject == None:
            if _sName in self.m_aHashMap:
                aObject = self.m_aHashMap[_sName]

        if aObject != None:
            try:
                nValue = NumericalHelper.toDouble(aObject)
            except ValueError, e:
                DebugHelper.writeInfo("can't convert a object to integer.")

        return nValue

    '''
    get a property and convert it to a boolean value
    @param _sName the string name of the property
    @param _bDefault if an error occur, return this value
    @return the boolean value of the property
    '''

    def getPropertyValueAsBoolean(self, _sName, _bDefault):
        aObject = None
        bValue = _bDefault
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
                DebugHelper.writeInfo(
                    "UnknownPropertyException caught: Name:=" + _sName)
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        if aObject != None:
            try:
                bValue = NumericalHelper.toBoolean(aObject)
            except ValueError, e:
                DebugHelper.writeInfo("can't convert a object to boolean.")

        return bValue

    '''
    get a property and convert it to a string value
    @param _sName the string name of the property
    @param _sDefault if an error occur, return this value
    @return the string value of the property
    '''

    def getPropertyValueAsString(self, _sName, _sDefault):
        aObject = None
        sValue = _sDefault
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        if aObject != None:
            try:
                sValue = AnyConverter.toString(aObject)
            except ValueError, e:
                DebugHelper.writeInfo("can't convert a object to string.")

        return sValue

    '''
    get a property and don't convert it
    @param _sName the string name of the property
    @return the object value of the property without any conversion
    '''

    def getPropertyValueAsObject(self, _sName):
        aObject = None
        if self.m_xPropertySet != None:
            try:
                aObject = self.m_xPropertySet.getPropertyValue(_sName)
            except com.sun.star.beans.UnknownPropertyException, e:
                DebugHelper.writeInfo(e.getMessage())
            except com.sun.star.lang.WrappedTargetException, e:
                DebugHelper.writeInfo(e.getMessage())

        return aObject

    '''
    Debug helper, to show all properties
    which are available in the given object.
    @param _xObj the object of which the properties should shown
    '''

    @classmethod
    def showProperties(self, _xObj):
        aHelper = PropertySetHelper.PropertySetHelper_unknown(_xObj)
        aHelper.showProperties()

    '''
    Debug helper, to show all properties which are available
    in the current object.
    '''

    def showProperties(self):
        sName = ""
        if self.m_xPropertySet != None:
            sName = self.m_xPropertySet.getImplementationName()

            xInfo = self.m_xPropertySet.getPropertySetInfo()
            aAllProperties = xInfo.getProperties()
            DebugHelper.writeInfo(
                "Show all properties of Implementation of :'" + sName + "'")
            i = 0
            while i < aAllProperties.length:
                DebugHelper.writeInfo(" - " + aAllProperties[i].Name)
                i += 1
        else:
            DebugHelper.writeInfo(
                "The given object don't support XPropertySet interface.")