xref: /AOO41X/main/odk/examples/DevelopersGuide/OfficeDev/Linguistic/PropChgHelper.java (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  *  The Contents of this file are made available subject to the terms of
4*cdf0e10cSrcweir  *  the BSD license.
5*cdf0e10cSrcweir  *
6*cdf0e10cSrcweir  *  Copyright 2000, 2010 Oracle and/or its affiliates.
7*cdf0e10cSrcweir  *  All rights reserved.
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  *  Redistribution and use in source and binary forms, with or without
10*cdf0e10cSrcweir  *  modification, are permitted provided that the following conditions
11*cdf0e10cSrcweir  *  are met:
12*cdf0e10cSrcweir  *  1. Redistributions of source code must retain the above copyright
13*cdf0e10cSrcweir  *     notice, this list of conditions and the following disclaimer.
14*cdf0e10cSrcweir  *  2. Redistributions in binary form must reproduce the above copyright
15*cdf0e10cSrcweir  *     notice, this list of conditions and the following disclaimer in the
16*cdf0e10cSrcweir  *     documentation and/or other materials provided with the distribution.
17*cdf0e10cSrcweir  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
18*cdf0e10cSrcweir  *     contributors may be used to endorse or promote products derived
19*cdf0e10cSrcweir  *     from this software without specific prior written permission.
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22*cdf0e10cSrcweir  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23*cdf0e10cSrcweir  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24*cdf0e10cSrcweir  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25*cdf0e10cSrcweir  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26*cdf0e10cSrcweir  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27*cdf0e10cSrcweir  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28*cdf0e10cSrcweir  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29*cdf0e10cSrcweir  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
30*cdf0e10cSrcweir  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
31*cdf0e10cSrcweir  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32*cdf0e10cSrcweir  *
33*cdf0e10cSrcweir  *************************************************************************/
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir import com.sun.star.linguistic2.XLinguServiceEventBroadcaster;
36*cdf0e10cSrcweir import com.sun.star.linguistic2.XLinguServiceEventListener;
37*cdf0e10cSrcweir import com.sun.star.linguistic2.LinguServiceEvent;
38*cdf0e10cSrcweir import com.sun.star.beans.XPropertySet;
39*cdf0e10cSrcweir import com.sun.star.beans.XPropertyChangeListener;
40*cdf0e10cSrcweir import com.sun.star.beans.PropertyChangeEvent;
41*cdf0e10cSrcweir import com.sun.star.lang.EventObject;
42*cdf0e10cSrcweir import com.sun.star.uno.XInterface;
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir import java.util.ArrayList;
45*cdf0e10cSrcweir 
46*cdf0e10cSrcweir public class PropChgHelper implements
47*cdf0e10cSrcweir         XPropertyChangeListener,
48*cdf0e10cSrcweir         XLinguServiceEventBroadcaster
49*cdf0e10cSrcweir {
50*cdf0e10cSrcweir     XInterface          xEvtSource;
51*cdf0e10cSrcweir     String[]            aPropNames;
52*cdf0e10cSrcweir     XPropertySet        xPropSet;
53*cdf0e10cSrcweir     ArrayList           aLngSvcEvtListeners;
54*cdf0e10cSrcweir 
55*cdf0e10cSrcweir     public PropChgHelper(
56*cdf0e10cSrcweir             XInterface      xEvtSource,
57*cdf0e10cSrcweir             String[]        aPropNames )
58*cdf0e10cSrcweir     {
59*cdf0e10cSrcweir         this.xEvtSource = xEvtSource;
60*cdf0e10cSrcweir         this.aPropNames = aPropNames;
61*cdf0e10cSrcweir         xPropSet        = null;
62*cdf0e10cSrcweir         aLngSvcEvtListeners = new ArrayList();
63*cdf0e10cSrcweir     }
64*cdf0e10cSrcweir 
65*cdf0e10cSrcweir     public XInterface GetEvtSource()
66*cdf0e10cSrcweir     {
67*cdf0e10cSrcweir         return xEvtSource;
68*cdf0e10cSrcweir     }
69*cdf0e10cSrcweir 
70*cdf0e10cSrcweir     public XPropertySet GetPropSet()
71*cdf0e10cSrcweir     {
72*cdf0e10cSrcweir         return xPropSet;
73*cdf0e10cSrcweir     }
74*cdf0e10cSrcweir 
75*cdf0e10cSrcweir     public String[] GetPropNames()
76*cdf0e10cSrcweir     {
77*cdf0e10cSrcweir         return aPropNames;
78*cdf0e10cSrcweir     }
79*cdf0e10cSrcweir 
80*cdf0e10cSrcweir     public void LaunchEvent( LinguServiceEvent aEvt )
81*cdf0e10cSrcweir     {
82*cdf0e10cSrcweir         int nCnt = aLngSvcEvtListeners.size();
83*cdf0e10cSrcweir         for (int i = 0;  i < nCnt;  ++i)
84*cdf0e10cSrcweir         {
85*cdf0e10cSrcweir             XLinguServiceEventListener xLstnr =
86*cdf0e10cSrcweir                     (XLinguServiceEventListener) aLngSvcEvtListeners.get(i);
87*cdf0e10cSrcweir             if (xLstnr != null)
88*cdf0e10cSrcweir                 xLstnr.processLinguServiceEvent( aEvt );
89*cdf0e10cSrcweir         }
90*cdf0e10cSrcweir     }
91*cdf0e10cSrcweir 
92*cdf0e10cSrcweir     public void AddAsListenerTo( XPropertySet xPropertySet )
93*cdf0e10cSrcweir     {
94*cdf0e10cSrcweir         // do not listen any longer to the old property set (if any)
95*cdf0e10cSrcweir         RemoveAsListener();
96*cdf0e10cSrcweir 
97*cdf0e10cSrcweir         // set new property set to be used and register as listener to it
98*cdf0e10cSrcweir         xPropSet = xPropertySet;
99*cdf0e10cSrcweir         if (xPropSet != null)
100*cdf0e10cSrcweir         {
101*cdf0e10cSrcweir             int nLen = aPropNames.length;
102*cdf0e10cSrcweir             for (int i = 0;  i < nLen;  ++i)
103*cdf0e10cSrcweir             {
104*cdf0e10cSrcweir                 if (aPropNames[i].length() != 0)
105*cdf0e10cSrcweir                 {
106*cdf0e10cSrcweir                     try {
107*cdf0e10cSrcweir                         xPropSet.addPropertyChangeListener(
108*cdf0e10cSrcweir                                 aPropNames[i], (XPropertyChangeListener) this );
109*cdf0e10cSrcweir                     }
110*cdf0e10cSrcweir                     catch( Exception e ) {
111*cdf0e10cSrcweir                     }
112*cdf0e10cSrcweir                 }
113*cdf0e10cSrcweir             }
114*cdf0e10cSrcweir         }
115*cdf0e10cSrcweir     }
116*cdf0e10cSrcweir 
117*cdf0e10cSrcweir     public void RemoveAsListener()
118*cdf0e10cSrcweir     {
119*cdf0e10cSrcweir         if (xPropSet != null)
120*cdf0e10cSrcweir         {
121*cdf0e10cSrcweir             int nLen = aPropNames.length;
122*cdf0e10cSrcweir             for (int i = 0;  i < nLen;  ++i)
123*cdf0e10cSrcweir             {
124*cdf0e10cSrcweir                 if (aPropNames[i].length() != 0)
125*cdf0e10cSrcweir                 {
126*cdf0e10cSrcweir                     try {
127*cdf0e10cSrcweir                         xPropSet.removePropertyChangeListener(
128*cdf0e10cSrcweir                                 aPropNames[i], (XPropertyChangeListener) this );
129*cdf0e10cSrcweir                     }
130*cdf0e10cSrcweir                     catch( Exception e ) {
131*cdf0e10cSrcweir                     }
132*cdf0e10cSrcweir                 }
133*cdf0e10cSrcweir             }
134*cdf0e10cSrcweir 
135*cdf0e10cSrcweir             xPropSet = null;
136*cdf0e10cSrcweir         }
137*cdf0e10cSrcweir     }
138*cdf0e10cSrcweir 
139*cdf0e10cSrcweir     // __________ interface methods __________
140*cdf0e10cSrcweir 
141*cdf0e10cSrcweir     //***************
142*cdf0e10cSrcweir 	// XEventListener
143*cdf0e10cSrcweir     //***************
144*cdf0e10cSrcweir     public void disposing( EventObject aSource )
145*cdf0e10cSrcweir             throws com.sun.star.uno.RuntimeException
146*cdf0e10cSrcweir     {
147*cdf0e10cSrcweir         if (aSource.Source == xPropSet)
148*cdf0e10cSrcweir         {
149*cdf0e10cSrcweir             RemoveAsListener();
150*cdf0e10cSrcweir         }
151*cdf0e10cSrcweir     }
152*cdf0e10cSrcweir 
153*cdf0e10cSrcweir     //************************
154*cdf0e10cSrcweir 	// XPropertyChangeListener
155*cdf0e10cSrcweir     //************************
156*cdf0e10cSrcweir     public void propertyChange( PropertyChangeEvent aEvt )
157*cdf0e10cSrcweir             throws com.sun.star.uno.RuntimeException
158*cdf0e10cSrcweir     {
159*cdf0e10cSrcweir         // will be overloaded in derived classes
160*cdf0e10cSrcweir     }
161*cdf0e10cSrcweir 
162*cdf0e10cSrcweir     //******************************
163*cdf0e10cSrcweir 	// XLinguServiceEventBroadcaster
164*cdf0e10cSrcweir     //******************************
165*cdf0e10cSrcweir     public boolean addLinguServiceEventListener(
166*cdf0e10cSrcweir             XLinguServiceEventListener xListener )
167*cdf0e10cSrcweir         throws com.sun.star.uno.RuntimeException
168*cdf0e10cSrcweir     {
169*cdf0e10cSrcweir         boolean bRes = false;
170*cdf0e10cSrcweir         if (xListener != null)
171*cdf0e10cSrcweir         {
172*cdf0e10cSrcweir             bRes = aLngSvcEvtListeners.add( xListener );
173*cdf0e10cSrcweir         }
174*cdf0e10cSrcweir         return bRes;
175*cdf0e10cSrcweir     }
176*cdf0e10cSrcweir 
177*cdf0e10cSrcweir     public boolean removeLinguServiceEventListener(
178*cdf0e10cSrcweir             XLinguServiceEventListener xListener )
179*cdf0e10cSrcweir         throws com.sun.star.uno.RuntimeException
180*cdf0e10cSrcweir     {
181*cdf0e10cSrcweir         boolean bRes = false;
182*cdf0e10cSrcweir         if (xListener != null)
183*cdf0e10cSrcweir         {
184*cdf0e10cSrcweir             int nIdx = aLngSvcEvtListeners.indexOf( xListener );
185*cdf0e10cSrcweir             if (nIdx != -1)
186*cdf0e10cSrcweir             {
187*cdf0e10cSrcweir                 aLngSvcEvtListeners.remove( nIdx );
188*cdf0e10cSrcweir                 bRes = true;
189*cdf0e10cSrcweir             }
190*cdf0e10cSrcweir         }
191*cdf0e10cSrcweir         return bRes;
192*cdf0e10cSrcweir     }
193*cdf0e10cSrcweir };
194*cdf0e10cSrcweir 
195