org.jinterop.dcom.win32
Class JIOleFrame

java.lang.Object
  extended by org.jinterop.dcom.win32.JIOleFrame
All Implemented Interfaces:
IJIUnknown, IJIOleInPlaceFrame, IJIOleInPlaceUIWindow, IJIOleWindow

public final class JIOleFrame
extends java.lang.Object
implements IJIOleInPlaceFrame

Frame container for Ole controls.

Since:
1.07

Field Summary
static java.lang.String IID_CommandTarget
           
 
Fields inherited from interface org.jinterop.dcom.win32.IJIOleInPlaceFrame
IID
 
Constructor Summary
JIOleFrame(JISession session, int frameIdentifier, IJIComObject inplaceObject)
          Creates a frame object.
 
Method Summary
 void addRef()
          Increases the reference count on the actual COM server by 5 (currently hardcoded).
 void contextSensitiveHelp(boolean fEnterMode)
           
 void enableModeless(boolean fEnable)
           
 JIStruct getBorder()
           
 int getWindow()
           
 JIStruct insertMenus(int hmenuShared, JIStruct lpMenuWidths)
          typedef struct tagOleMenuGroupWidths { LONG width[6]; } OLEMENUGROUPWIDTHS, * LPOLEMENUGROUPWIDTHS;
 IJIUnknown queryInterface(java.lang.String iid)
          Used to retrieve interface pointers based on iid.
 void release()
           Decreases the reference count on the actual COM server by 5 (currently hardcoded).
 void removeMenus(int hmenuShared)
           
 void requestBorderSpace(JIStruct pborderwidths)
           
 void setActiveObject(JIInterfacePointer pActiveObject, JIString pszObjName)
           
 void setBorderSpace(JIStruct pborderwidths)
           
 void setMenu(int hmenuShared, int holemenu, int hwndActiveObject)
           
 void setStatusText(JIString pszStatusText)
           
 void testShowWindow()
           
 void translateAccelerator(JIStruct lpmsg, int wID)
          typedef struct tagMSG { // msg HWND hwnd; UINT message; WPARAM wParam; LPARAM lParam; DWORD time; POINT pt; } MSG;
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IID_CommandTarget

public static final java.lang.String IID_CommandTarget
See Also:
Constant Field Values
Constructor Detail

JIOleFrame

public JIOleFrame(JISession session,
                  int frameIdentifier,
                  IJIComObject inplaceObject)
           throws JIException
Creates a frame object.

Parameters:
session -
frameIdentifier - uniquely identifies the parent frame (Swing JFrame).
inplaceObject - object to be activated here.
Throws:
JIException
Method Detail

testShowWindow

public void testShowWindow()
                    throws JIException
Throws:
JIException

enableModeless

public void enableModeless(boolean fEnable)
                    throws JIException
Specified by:
enableModeless in interface IJIOleInPlaceFrame
Throws:
JIException

insertMenus

public JIStruct insertMenus(int hmenuShared,
                            JIStruct lpMenuWidths)
                     throws JIException
Description copied from interface: IJIOleInPlaceFrame
typedef struct tagOleMenuGroupWidths { LONG width[6]; } OLEMENUGROUPWIDTHS, * LPOLEMENUGROUPWIDTHS;

Specified by:
insertMenus in interface IJIOleInPlaceFrame
Throws:
JIException

removeMenus

public void removeMenus(int hmenuShared)
                 throws JIException
Specified by:
removeMenus in interface IJIOleInPlaceFrame
Throws:
JIException

setMenu

public void setMenu(int hmenuShared,
                    int holemenu,
                    int hwndActiveObject)
             throws JIException
Specified by:
setMenu in interface IJIOleInPlaceFrame
Throws:
JIException

setStatusText

public void setStatusText(JIString pszStatusText)
                   throws JIException
Specified by:
setStatusText in interface IJIOleInPlaceFrame
Throws:
JIException

translateAccelerator

public void translateAccelerator(JIStruct lpmsg,
                                 int wID)
                          throws JIException
Description copied from interface: IJIOleInPlaceFrame
typedef struct tagMSG { // msg HWND hwnd; UINT message; WPARAM wParam; LPARAM lParam; DWORD time; POINT pt; } MSG;

Specified by:
translateAccelerator in interface IJIOleInPlaceFrame
Throws:
JIException

getBorder

public JIStruct getBorder()
                   throws JIException
Specified by:
getBorder in interface IJIOleInPlaceUIWindow
Throws:
JIException

requestBorderSpace

public void requestBorderSpace(JIStruct pborderwidths)
                        throws JIException
Specified by:
requestBorderSpace in interface IJIOleInPlaceUIWindow
Throws:
JIException

setActiveObject

public void setActiveObject(JIInterfacePointer pActiveObject,
                            JIString pszObjName)
                     throws JIException
Specified by:
setActiveObject in interface IJIOleInPlaceUIWindow
Throws:
JIException

setBorderSpace

public void setBorderSpace(JIStruct pborderwidths)
                    throws JIException
Specified by:
setBorderSpace in interface IJIOleInPlaceUIWindow
Throws:
JIException

getWindow

public int getWindow()
              throws JIException
Specified by:
getWindow in interface IJIOleWindow
Throws:
JIException

contextSensitiveHelp

public void contextSensitiveHelp(boolean fEnterMode)
                          throws JIException
Specified by:
contextSensitiveHelp in interface IJIOleWindow
Throws:
JIException

queryInterface

public IJIUnknown queryInterface(java.lang.String iid)
                          throws JIException
Description copied from interface: IJIUnknown
Used to retrieve interface pointers based on iid.

Specified by:
queryInterface in interface IJIUnknown
Parameters:
iid - String representation of the IID (clsid).
Returns:
reference to the requested unknown.
Throws:
JIException

addRef

public void addRef()
            throws JIException
Description copied from interface: IJIUnknown

Increases the reference count on the actual COM server by 5 (currently hardcoded). The developer should refrain from calling this API, as referencing is maintained internally by the system. If the release is not called in conjunction with addRef then the COM Instance will not get garbage collected at the server.

Specified by:
addRef in interface IJIUnknown
Throws:
JIException

release

public void release()
             throws JIException
Description copied from interface: IJIUnknown

Decreases the reference count on the actual COM server by 5 (currently hardcoded). The developer should refrain from calling this API, as referencing is maintained internally by the system. If the release is not called in conjunction with addRef then the COM Instance will not get garbage collected at the server.

Specified by:
release in interface IJIUnknown
Throws:
JIException