1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski // __________ Imports __________ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import com.sun.star.uno.UnoRuntime; 27*b1cdbd2cSJim Jagielski 28*b1cdbd2cSJim Jagielski import java.lang.*; 29*b1cdbd2cSJim Jagielski import java.util.*; 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski // __________ Implementation __________ 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski /** 34*b1cdbd2cSJim Jagielski * It's implement a static container which hold 35*b1cdbd2cSJim Jagielski * all opened documents and her views alive. 36*b1cdbd2cSJim Jagielski * It's possible to register/deregister such views, 37*b1cdbd2cSJim Jagielski * to get information about these and it provides 38*b1cdbd2cSJim Jagielski * some global functionality - like termination of 39*b1cdbd2cSJim Jagielski * this demo application. 40*b1cdbd2cSJim Jagielski * 41*b1cdbd2cSJim Jagielski * @author Andreas Schlüns 42*b1cdbd2cSJim Jagielski * @created 01.03.2002 08:42 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielski public class ViewContainer extends Thread 45*b1cdbd2cSJim Jagielski { 46*b1cdbd2cSJim Jagielski // ____________________ 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski /** 49*b1cdbd2cSJim Jagielski * provides a singleton view container 50*b1cdbd2cSJim Jagielski * Neccessary for terminate(9 functionality to be able 51*b1cdbd2cSJim Jagielski * to call Runtime.runFinilization(). 52*b1cdbd2cSJim Jagielski * 53*b1cdbd2cSJim Jagielski * @return a reference to the singleton ViewContainer instance 54*b1cdbd2cSJim Jagielski */ getGlobalContainer()55*b1cdbd2cSJim Jagielski public static synchronized ViewContainer getGlobalContainer() 56*b1cdbd2cSJim Jagielski { 57*b1cdbd2cSJim Jagielski if (maSingleton==null) 58*b1cdbd2cSJim Jagielski maSingleton=new ViewContainer(); 59*b1cdbd2cSJim Jagielski return maSingleton; 60*b1cdbd2cSJim Jagielski } 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski // ____________________ 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski /** 65*b1cdbd2cSJim Jagielski * ctor 66*b1cdbd2cSJim Jagielski * It's private - because nobody should create any instance 67*b1cdbd2cSJim Jagielski * expect the only global one, which wil be created by ourself! 68*b1cdbd2cSJim Jagielski */ ViewContainer()69*b1cdbd2cSJim Jagielski private ViewContainer() 70*b1cdbd2cSJim Jagielski { 71*b1cdbd2cSJim Jagielski mlViews = new Vector(); 72*b1cdbd2cSJim Jagielski mlListener = new Vector(); 73*b1cdbd2cSJim Jagielski mbShutdownActive = false ; 74*b1cdbd2cSJim Jagielski Runtime.getRuntime().addShutdownHook(this); 75*b1cdbd2cSJim Jagielski } 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski // ____________________ 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski /** 80*b1cdbd2cSJim Jagielski * This register a new view inside this global container 81*b1cdbd2cSJim Jagielski * (if it doesnt already exist). 82*b1cdbd2cSJim Jagielski * 83*b1cdbd2cSJim Jagielski * @param aView view which whish to be registered inside this container 84*b1cdbd2cSJim Jagielski */ addView(Object aView)85*b1cdbd2cSJim Jagielski public void addView(Object aView) 86*b1cdbd2cSJim Jagielski { 87*b1cdbd2cSJim Jagielski synchronized(mlViews) 88*b1cdbd2cSJim Jagielski { 89*b1cdbd2cSJim Jagielski if(mlViews.contains(aView)==false) 90*b1cdbd2cSJim Jagielski mlViews.add(aView); 91*b1cdbd2cSJim Jagielski } 92*b1cdbd2cSJim Jagielski } 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski // ____________________ 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski /** 97*b1cdbd2cSJim Jagielski * This deregister a view from this global container. 98*b1cdbd2cSJim Jagielski * Normaly it should be the last reference to the view 99*b1cdbd2cSJim Jagielski * and her finalize() method should be called. 100*b1cdbd2cSJim Jagielski * If last view will be closed here - we terminate these 101*b1cdbd2cSJim Jagielski * java application too. Because there is no further 102*b1cdbd2cSJim Jagielski * visible frame anymore. 103*b1cdbd2cSJim Jagielski * 104*b1cdbd2cSJim Jagielski * @param aView 105*b1cdbd2cSJim Jagielski * view object which wish to be deregistered 106*b1cdbd2cSJim Jagielski */ removeView(Object aView)107*b1cdbd2cSJim Jagielski public void removeView(Object aView) 108*b1cdbd2cSJim Jagielski { 109*b1cdbd2cSJim Jagielski int nViewCount = 0; 110*b1cdbd2cSJim Jagielski synchronized(mlViews) 111*b1cdbd2cSJim Jagielski { 112*b1cdbd2cSJim Jagielski if(mlViews.contains(aView)==true) 113*b1cdbd2cSJim Jagielski mlViews.remove(aView); 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski nViewCount = mlViews.size(); 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski if (nViewCount<1) 118*b1cdbd2cSJim Jagielski mlViews = null; 119*b1cdbd2cSJim Jagielski } 120*b1cdbd2cSJim Jagielski // If this view is a registered shutdown listener on this view container 121*b1cdbd2cSJim Jagielski // too, we must call his interface and forget him as possible listener. 122*b1cdbd2cSJim Jagielski // It's neccessary to guarantee his dead ... 123*b1cdbd2cSJim Jagielski boolean bShutdownView = false; 124*b1cdbd2cSJim Jagielski synchronized(mlListener) 125*b1cdbd2cSJim Jagielski { 126*b1cdbd2cSJim Jagielski bShutdownView = mlListener.contains(aView); 127*b1cdbd2cSJim Jagielski if (bShutdownView==true) 128*b1cdbd2cSJim Jagielski mlListener.remove(aView); 129*b1cdbd2cSJim Jagielski } 130*b1cdbd2cSJim Jagielski if (bShutdownView==true) 131*b1cdbd2cSJim Jagielski ((IShutdownListener)aView).shutdown(); 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski // We use a system.exit() to finish the whole application. 134*b1cdbd2cSJim Jagielski // And further we have registered THIS instance as a possible shutdown 135*b1cdbd2cSJim Jagielski // hook at the runtime class. So our run() method will be called. 136*b1cdbd2cSJim Jagielski // Teh our view container should be empty - but 137*b1cdbd2cSJim Jagielski // our listener container can include some references. 138*b1cdbd2cSJim Jagielski // These objects wich to be informed then and release e.g. some 139*b1cdbd2cSJim Jagielski // remote references. 140*b1cdbd2cSJim Jagielski if (nViewCount<1) 141*b1cdbd2cSJim Jagielski { 142*b1cdbd2cSJim Jagielski boolean bNeccessary = false; 143*b1cdbd2cSJim Jagielski synchronized(this) 144*b1cdbd2cSJim Jagielski { 145*b1cdbd2cSJim Jagielski bNeccessary = ! mbShutdownActive; 146*b1cdbd2cSJim Jagielski } 147*b1cdbd2cSJim Jagielski if (bNeccessary==true) 148*b1cdbd2cSJim Jagielski { 149*b1cdbd2cSJim Jagielski System.out.println("call exit(0)!"); 150*b1cdbd2cSJim Jagielski System.exit(0); 151*b1cdbd2cSJim Jagielski } 152*b1cdbd2cSJim Jagielski } 153*b1cdbd2cSJim Jagielski } 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski // ____________________ 156*b1cdbd2cSJim Jagielski 157*b1cdbd2cSJim Jagielski /** 158*b1cdbd2cSJim Jagielski * add/remove listener for possibe shutdown events 159*b1cdbd2cSJim Jagielski */ addListener( IShutdownListener rListener )160*b1cdbd2cSJim Jagielski public void addListener( IShutdownListener rListener ) 161*b1cdbd2cSJim Jagielski { 162*b1cdbd2cSJim Jagielski synchronized(mlListener) 163*b1cdbd2cSJim Jagielski { 164*b1cdbd2cSJim Jagielski if ( ! mlListener.contains(rListener) ) 165*b1cdbd2cSJim Jagielski mlListener.add(rListener); 166*b1cdbd2cSJim Jagielski } 167*b1cdbd2cSJim Jagielski } 168*b1cdbd2cSJim Jagielski 169*b1cdbd2cSJim Jagielski // ____________________ 170*b1cdbd2cSJim Jagielski removeListener( IShutdownListener rListener )171*b1cdbd2cSJim Jagielski public void removeListener( IShutdownListener rListener ) 172*b1cdbd2cSJim Jagielski { 173*b1cdbd2cSJim Jagielski synchronized(mlListener) 174*b1cdbd2cSJim Jagielski { 175*b1cdbd2cSJim Jagielski if ( mlListener.contains(rListener) ) 176*b1cdbd2cSJim Jagielski mlListener.remove(rListener); 177*b1cdbd2cSJim Jagielski } 178*b1cdbd2cSJim Jagielski } 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski // ____________________ 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski /** 183*b1cdbd2cSJim Jagielski * Is called from current runtime system of the java machine 184*b1cdbd2cSJim Jagielski * on shutdown. We inform all current registered listener and 185*b1cdbd2cSJim Jagielski * views. They should deinitialize her internal things then. 186*b1cdbd2cSJim Jagielski */ run()187*b1cdbd2cSJim Jagielski public void run() 188*b1cdbd2cSJim Jagielski { 189*b1cdbd2cSJim Jagielski synchronized(this) 190*b1cdbd2cSJim Jagielski { 191*b1cdbd2cSJim Jagielski if (mbShutdownActive) 192*b1cdbd2cSJim Jagielski return; 193*b1cdbd2cSJim Jagielski mbShutdownActive=true; 194*b1cdbd2cSJim Jagielski } 195*b1cdbd2cSJim Jagielski 196*b1cdbd2cSJim Jagielski while( true ) 197*b1cdbd2cSJim Jagielski { 198*b1cdbd2cSJim Jagielski IShutdownListener aListener = null; 199*b1cdbd2cSJim Jagielski synchronized(mlListener) 200*b1cdbd2cSJim Jagielski { 201*b1cdbd2cSJim Jagielski try{ 202*b1cdbd2cSJim Jagielski aListener = (IShutdownListener)mlListener.firstElement(); 203*b1cdbd2cSJim Jagielski } catch(java.util.NoSuchElementException exEmpty) {} 204*b1cdbd2cSJim Jagielski } 205*b1cdbd2cSJim Jagielski if (aListener==null) 206*b1cdbd2cSJim Jagielski break; 207*b1cdbd2cSJim Jagielski 208*b1cdbd2cSJim Jagielski aListener.shutdown(); 209*b1cdbd2cSJim Jagielski // May this listener has dergeistered himself. 210*b1cdbd2cSJim Jagielski // But if not we must do it for him. Our own 211*b1cdbd2cSJim Jagielski // method "removeListener()" ignore requests for 212*b1cdbd2cSJim Jagielski // already gone listener objects. 213*b1cdbd2cSJim Jagielski removeListener(aListener); 214*b1cdbd2cSJim Jagielski } 215*b1cdbd2cSJim Jagielski 216*b1cdbd2cSJim Jagielski if (mlViews!=null) 217*b1cdbd2cSJim Jagielski { 218*b1cdbd2cSJim Jagielski synchronized(mlViews) 219*b1cdbd2cSJim Jagielski { 220*b1cdbd2cSJim Jagielski mlViews.clear(); 221*b1cdbd2cSJim Jagielski mlViews = null; 222*b1cdbd2cSJim Jagielski } 223*b1cdbd2cSJim Jagielski } 224*b1cdbd2cSJim Jagielski 225*b1cdbd2cSJim Jagielski if (mlListener!=null) 226*b1cdbd2cSJim Jagielski { 227*b1cdbd2cSJim Jagielski synchronized(mlListener) 228*b1cdbd2cSJim Jagielski { 229*b1cdbd2cSJim Jagielski mlListener.clear(); 230*b1cdbd2cSJim Jagielski mlListener = null; 231*b1cdbd2cSJim Jagielski } 232*b1cdbd2cSJim Jagielski } 233*b1cdbd2cSJim Jagielski } 234*b1cdbd2cSJim Jagielski 235*b1cdbd2cSJim Jagielski // ____________________ 236*b1cdbd2cSJim Jagielski 237*b1cdbd2cSJim Jagielski /** 238*b1cdbd2cSJim Jagielski * @const BASICNAME it's used to create uinque names for all regieterd views 239*b1cdbd2cSJim Jagielski */ 240*b1cdbd2cSJim Jagielski private static final String BASICNAME = "Document View "; 241*b1cdbd2cSJim Jagielski 242*b1cdbd2cSJim Jagielski // ____________________ 243*b1cdbd2cSJim Jagielski 244*b1cdbd2cSJim Jagielski /** 245*b1cdbd2cSJim Jagielski * @member mbInplace indicates using of inplace office frames instead of outplace ones 246*b1cdbd2cSJim Jagielski * @member maSingleton singleton instance of this view container 247*b1cdbd2cSJim Jagielski * @member mlViews list of all currently registered document views 248*b1cdbd2cSJim Jagielski * @member mlListener list of all currently registered shutdown listener 249*b1cdbd2cSJim Jagielski * @member mbShutdownActive if this shutdown hook already was started it's not a good idea to 250*b1cdbd2cSJim Jagielski * call System.exit() again for other conditions. 251*b1cdbd2cSJim Jagielski * We supress it by using this variable! 252*b1cdbd2cSJim Jagielski */ 253*b1cdbd2cSJim Jagielski public static boolean mbInplace = false ; 254*b1cdbd2cSJim Jagielski private static ViewContainer maSingleton = null ; 255*b1cdbd2cSJim Jagielski private Vector mlViews ; 256*b1cdbd2cSJim Jagielski private Vector mlListener ; 257*b1cdbd2cSJim Jagielski private boolean mbShutdownActive ; 258*b1cdbd2cSJim Jagielski } 259