odk/examples/DevelopersGuide/Drawing/PageHelper.java

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  the BSD license.
   5  *
   6  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *  All rights reserved.
   8  *
   9  *  Redistribution and use in source and binary forms, with or without
  10  *  modification, are permitted provided that the following conditions
  11  *  are met:
  12  *  1. Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *  2. Redistributions in binary form must reproduce the above copyright
  15  *     notice, this list of conditions and the following disclaimer in the
  16  *     documentation and/or other materials provided with the distribution.
  17  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  18  *     contributors may be used to endorse or promote products derived
  19  *     from this software without specific prior written permission.
  20  *
  21  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  29  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  30  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  31  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  *************************************************************************/
  34
  35 // __________ Imports __________
  36
  37 import com.sun.star.uno.UnoRuntime;
  38 import com.sun.star.lang.XComponent;
  39 import com.sun.star.lang.XServiceInfo;
  40
  41 import com.sun.star.awt.Size;
  42
  43 import com.sun.star.beans.XPropertySet;
  44
  45 import com.sun.star.drawing.XDrawPage;
  46 import com.sun.star.drawing.XDrawPages;
  47 import com.sun.star.drawing.XDrawPagesSupplier;
  48 import com.sun.star.drawing.XMasterPageTarget;
  49 import com.sun.star.drawing.XMasterPagesSupplier;
  50
  51 import com.sun.star.presentation.XPresentationPage;
  52 import com.sun.star.presentation.XHandoutMasterSupplier;
  53
  54
  55 public class PageHelper
  56 {
  57     // __________ static helper methods __________
  58
  59     // __________ draw pages __________
  60
  61     /** get the page count for standard pages
  62     */
  63     static public int getDrawPageCount( XComponent xComponent )
  64     {
  65         XDrawPagesSupplier xDrawPagesSupplier =
  66             UnoRuntime.queryInterface(
  67                     XDrawPagesSupplier.class, xComponent );
  68         XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
  69         return xDrawPages.getCount();
  70     }
  71
  72     /** get draw page by index
  73     */
  74     static public XDrawPage getDrawPageByIndex( XComponent xComponent, int nIndex )
  75         throws com.sun.star.lang.IndexOutOfBoundsException,
  76             com.sun.star.lang.WrappedTargetException
  77     {
  78         XDrawPagesSupplier xDrawPagesSupplier =
  79             UnoRuntime.queryInterface(
  80                     XDrawPagesSupplier.class, xComponent );
  81         XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
  82         return UnoRuntime.queryInterface(XDrawPage.class, xDrawPages.getByIndex( nIndex ));
  83     }
  84
  85     /** creates and inserts a draw page into the giving position,
  86         the method returns the new created page
  87     */
  88     static public XDrawPage insertNewDrawPageByIndex( XComponent xComponent, int nIndex )
  89         throws Exception
  90     {
  91         XDrawPagesSupplier xDrawPagesSupplier =
  92             UnoRuntime.queryInterface(
  93                     XDrawPagesSupplier.class, xComponent );
  94         XDrawPages xDrawPages = xDrawPagesSupplier.getDrawPages();
  95         return xDrawPages.insertNewByIndex( nIndex );
  96     }
  97
  98
  99
 100     /** get size of the given page
 101     */
 102     static public Size getPageSize( XDrawPage xDrawPage )
 103         throws com.sun.star.beans.UnknownPropertyException,
 104             com.sun.star.lang.WrappedTargetException
 105     {
 106         XPropertySet xPageProperties = UnoRuntime.queryInterface( XPropertySet.class, xDrawPage );
 107         return new Size(
 108             ((Integer)xPageProperties.getPropertyValue( "Width" )).intValue(),
 109             ((Integer)xPageProperties.getPropertyValue( "Height" )).intValue() );
 110     }
 111
 112     // __________ master pages __________
 113
 114     /** get the page count for master pages
 115     */
 116     static public int getMasterPageCount( XComponent xComponent )
 117     {
 118         XMasterPagesSupplier xMasterPagesSupplier =
 119             UnoRuntime.queryInterface(
 120                     XMasterPagesSupplier.class, xComponent );
 121         XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
 122         return xDrawPages.getCount();
 123     }
 124
 125     /** get master page by index
 126     */
 127     static public XDrawPage getMasterPageByIndex( XComponent xComponent, int nIndex )
 128         throws com.sun.star.lang.IndexOutOfBoundsException,
 129             com.sun.star.lang.WrappedTargetException
 130     {
 131         XMasterPagesSupplier xMasterPagesSupplier =
 132             UnoRuntime.queryInterface(
 133                     XMasterPagesSupplier.class, xComponent );
 134         XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
 135         return UnoRuntime.queryInterface(XDrawPage.class, xDrawPages.getByIndex( nIndex ));
 136     }
 137
 138     /** creates and inserts a new master page into the giving position,
 139         the method returns the new created page
 140     */
 141     static public XDrawPage insertNewMasterPageByIndex( XComponent xComponent, int nIndex )
 142     {
 143         XMasterPagesSupplier xMasterPagesSupplier =
 144             UnoRuntime.queryInterface(
 145                     XMasterPagesSupplier.class, xComponent );
 146         XDrawPages xDrawPages = xMasterPagesSupplier.getMasterPages();
 147         return xDrawPages.insertNewByIndex( nIndex );
 148     }
 149
 150
 151
 152
 153
 154     /** sets given masterpage at the drawpage
 155     */
 156     static public void setMasterPage( XDrawPage xDrawPage, XDrawPage xMasterPage )
 157     {
 158         XMasterPageTarget xMasterPageTarget =
 159             UnoRuntime.queryInterface(
 160                     XMasterPageTarget.class, xDrawPage );
 161         xMasterPageTarget.setMasterPage( xMasterPage );
 162     }
 163
 164     // __________ presentation pages __________
 165
 166     /** test if a Presentation Document is supported.
 167         This is important, because only presentation documents
 168         have notes and handout pages
 169     */
 170     static public boolean isImpressDocument( XComponent xComponent )
 171     {
 172         XServiceInfo xInfo = UnoRuntime.queryInterface(
 173                 XServiceInfo.class, xComponent );
 174         return xInfo.supportsService( "com.sun.star.presentation.PresentationDocument" );
 175     }
 176
 177     /** in impress documents each normal draw page has a corresponding notes page
 178     */
 179     static public XDrawPage getNotesPage( XDrawPage xDrawPage )
 180     {
 181         XPresentationPage aPresentationPage =
 182             UnoRuntime.queryInterface(
 183                     XPresentationPage.class, xDrawPage );
 184         return aPresentationPage.getNotesPage();
 185     }
 186
 187     /** in impress each documents has one handout page
 188     */
 189     static public XDrawPage getHandoutMasterPage( XComponent xComponent )
 190     {
 191         XHandoutMasterSupplier aHandoutMasterSupplier =
 192             UnoRuntime.queryInterface(
 193                     XHandoutMasterSupplier.class, xComponent );
 194         return aHandoutMasterSupplier.getHandoutMasterPage();
 195     }
 196 }