odk/examples/DevelopersGuide/Forms/ButtonOperator.java

   1 /*************************************************************************
   2  *
   3  *  $RCSfile: ButtonOperator.java,v $
   4  *
   5  *  $Revision: 1.4 $
   6  *
   7  *  last change: $Author: rt $ $Date: 2005-01-31 16:27:59 $
   8  *
   9  *  The Contents of this file are made available subject to the terms of
  10  *  the BSD license.
  11  *
  12  *  Copyright (c) 2003 by Sun Microsystems, Inc.
  13  *  All rights reserved.
  14  *
  15  *  Redistribution and use in source and binary forms, with or without
  16  *  modification, are permitted provided that the following conditions
  17  *  are met:
  18  *  1. Redistributions of source code must retain the above copyright
  19  *     notice, this list of conditions and the following disclaimer.
  20  *  2. Redistributions in binary form must reproduce the above copyright
  21  *     notice, this list of conditions and the following disclaimer in the
  22  *     documentation and/or other materials provided with the distribution.
  23  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  24  *     contributors may be used to endorse or promote products derived
  25  *     from this software without specific prior written permission.
  26  *
  27  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  30  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  31  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  32  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  33  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  34  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  35  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  36  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  37  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  *
  39  *************************************************************************/
  40 package org.openoffice.sdk.forms;
  41
  42 // java base stuff
  43 import com.sun.star.awt.ActionEvent;
  44 import com.sun.star.awt.XActionListener;
  45 import com.sun.star.awt.XButton;
  46 import com.sun.star.beans.XPropertySet;
  47 import com.sun.star.form.runtime.FormOperations;
  48 import com.sun.star.form.runtime.XFeatureInvalidation;
  49 import com.sun.star.form.runtime.XFormOperations;
  50 import com.sun.star.lang.EventObject;
  51 import com.sun.star.uno.UnoRuntime;
  52 import com.sun.star.uno.XComponentContext;
  53 import java.util.Vector;
  54
  55
  56 /**************************************************************************/
  57 /** a helper class for operating the buttons
  58 */
  59 public class ButtonOperator implements XActionListener, XFeatureInvalidation
  60 {
  61     private XComponentContext   m_componentContext;
  62     private DocumentHelper              m_aDocument;
  63     private XPropertySet        m_form;
  64     private XFormOperations     m_formOperations;
  65
  66     private Vector                              m_aButtons;
  67
  68     /* ------------------------------------------------------------------ */
  69     /** ctor
  70     */
  71     public ButtonOperator( XComponentContext xCtx, DocumentHelper aDocument, XPropertySet _form )
  72     {
  73         m_componentContext = xCtx;
  74         m_aDocument = aDocument;
  75         m_form = _form;
  76         m_aButtons = new Vector();
  77     }
  78
  79     /* ------------------------------------------------------------------ */
  80     private short getAssociatedFormFeature( XPropertySet _buttonModel )
  81     {
  82         short formFeature = -1;
  83         try
  84         {
  85             formFeature = Short.valueOf( (String)_buttonModel.getPropertyValue( "Tag" ) );
  86         }
  87         catch( com.sun.star.uno.Exception e )
  88         {
  89         }
  90         return formFeature;
  91     }
  92
  93     /* ------------------------------------------------------------------ */
  94     /** get's the button which we operate and which is responsible for a given URL
  95     */
  96     private XPropertySet getButton( short _formFeature )
  97     {
  98         for ( int i=0; i < m_aButtons.size(); ++i )
  99         {
 100             XPropertySet button = (XPropertySet)m_aButtons.elementAt( i );
 101             if ( _formFeature == getAssociatedFormFeature( button ) )
 102                 return button;
 103         }
 104         return null;
 105     }
 106
 107     /* ------------------------------------------------------------------ */
 108     /** announces a button which the operator should be responsible for
 109     */
 110     private int getButtonIndex( XPropertySet xButton )
 111     {
 112         int nPos = -1;
 113         for ( int i=0; ( i < m_aButtons.size() ) && ( -1 == nPos ); ++i )
 114         {
 115             if ( xButton.equals( m_aButtons.elementAt( i ) ) )
 116                 nPos = i;
 117         }
 118         return nPos;
 119     }
 120
 121     /* ------------------------------------------------------------------ */
 122     /** announces a button which the operator should be responsible for
 123     */
 124     public void addButton( XPropertySet _buttonModel, short _formFeature  ) throws java.lang.Exception
 125     {
 126         // the current view to the document
 127         DocumentViewHelper aCurrentView = m_aDocument.getCurrentView();
 128
 129         // add a listener so we get noticed if the user presses the button
 130         XButton xButtonControl = (XButton)UnoRuntime.queryInterface( XButton.class,
 131             aCurrentView.getFormControl( _buttonModel ) );
 132         xButtonControl.addActionListener( this );
 133
 134         _buttonModel.setPropertyValue( "Tag", String.valueOf( _formFeature ) );
 135
 136         // remember the button
 137         m_aButtons.add( _buttonModel );
 138     }
 139
 140     /* ------------------------------------------------------------------ */
 141     public void revokeButton( XPropertySet xButtonModel )
 142     {
 143         int nPos = getButtonIndex( xButtonModel );
 144         if ( -1 < nPos )
 145         {
 146             m_aButtons.remove( nPos );
 147         }
 148     }
 149
 150     /* ==================================================================
 151        = XActionListener
 152        ================================================================== */
 153     /* ------------------------------------------------------------------ */
 154     /* called when a button has been pressed
 155     */
 156     public void actionPerformed( ActionEvent aEvent ) throws com.sun.star.uno.RuntimeException
 157     {
 158         // get the model's name
 159         XPropertySet buttonModel = (XPropertySet)FLTools.getModel( aEvent.Source, XPropertySet.class );
 160         try
 161         {
 162             short formFeature = getAssociatedFormFeature( buttonModel );
 163             if ( formFeature != -1 )
 164                 m_formOperations.execute( formFeature );
 165         }
 166         catch( final com.sun.star.uno.Exception e )
 167         {
 168         }
 169     }
 170
 171     /* ------------------------------------------------------------------ */
 172     /* (to be) called when the form layer has been switched to alive mode
 173      * @todo
 174      *  register as listener somewhere ...
 175     */
 176     public void onFormsAlive()
 177     {
 178         try
 179         {
 180             m_formOperations = FormOperations.createWithFormController(
 181                 m_componentContext, m_aDocument.getCurrentView().getFormController( m_form ) );
 182             m_formOperations.setFeatureInvalidation( this );
 183             invalidateAllFeatures();
 184         }
 185         catch( final com.sun.star.uno.Exception e )
 186         {
 187         }
 188     }
 189
 190     /* ==================================================================
 191        = XEventListener
 192        ================================================================== */
 193     public void disposing( EventObject aEvent )
 194     {
 195         // not interested in
 196     }
 197
 198     /* ==================================================================
 199        = XFeatureInvalidation
 200        ================================================================== */
 201     private void updateButtonState( XPropertySet _buttonModel, short _formFeature )
 202     {
 203         try
 204         {
 205             _buttonModel.setPropertyValue( "Enabled", m_formOperations.isEnabled( _formFeature ) );
 206         }
 207         catch( com.sun.star.uno.Exception e )
 208         {
 209         }
 210     }
 211
 212     public void invalidateFeatures( short[] _features ) throws com.sun.star.uno.RuntimeException
 213     {
 214         for ( int i=0; i<_features.length; ++i )
 215         {
 216             XPropertySet buttonModel = getButton( _features[i] );
 217             if ( buttonModel != null )
 218                 updateButtonState( buttonModel, _features[i] );
 219         }
 220     }
 221
 222     public void invalidateAllFeatures() throws com.sun.star.uno.RuntimeException
 223     {
 224         for ( int i=0; i < m_aButtons.size(); ++i )
 225         {
 226             XPropertySet buttonModel = (XPropertySet)m_aButtons.elementAt( i );
 227             updateButtonState( buttonModel, getAssociatedFormFeature( buttonModel ) );
 228         }
 229     }
 230 };
 231