com.goldencode.p2j.ui

Class ControlFrameWidget.ControlFrameComObjectImpl

java.lang.Object

com.goldencode.p2j.comauto.ComObject

com.goldencode.p2j.ui.ControlFrameWidget.ControlFrameComObjectImpl

All Implemented Interfaces:

ControlFrameComObject, Deletable, Nameable, WrappedResource

Enclosing class:

ControlFrameWidget

public class ControlFrameWidget.ControlFrameComObjectImpl
extends ComObject
implements ControlFrameComObject

Each Control Frame has a peer interface that allows to communicate with the ActiveX.

Field Summary

Fields inherited from class com.goldencode.p2j.comauto.ComObject

includeUnannotatedMethods, LOGGER, methodTable, propertyTable

Constructor Summary

Constructors

Constructor and Description
ControlFrameComObjectImpl() Public default constructor.

Method Summary

Modifier and Type	Method and Description
void	delete() Deleting objects of this type is illegal.
comhandle	getActiveX(java.lang.String axName) Obtain a (com-)handle to a specific Java emulated ActiveX, if such instance exist.
java.lang.String	getActivexName() Obtain the name of this ActiveX object.
comhandle	getControlName() The component handle to an ActiveX control that has the specified design-time name (Control-Name) and that is loaded into the control-frame.
comhandle	getControls() Returns a control collection from this control frame.
handle	getFrameHandle() Gets the FRAME attribute, which is the containing frame instance, as a handle.
integer	getHeight() Obtain the height of the widget or the screen display used in the current session, in pixels.
integer	getLeft() Obtain the left of the widget or the screen display used in the current session, in pixels.
java.lang.String	getName() Obtain the legacy name of this COM object.
BaseDataType	getProperty(java.lang.String prop, java.lang.Object... indices) Obtain a property value from the COM object stored in this handle.
integer	getTop() Obtain the top of the widget or the screen display used in the current session, in pixels.
handle	getWidgetHandle() Returns the handle of the control frame associated with the control-frame COM object.
integer	getWidgetId() Gets the WIDGET-ID writable attribute.
integer	getWidth() Obtain the width of the widget or the screen display used in the current session, in pixels.
logical	loadControls(java.lang.String wrxFile, java.lang.String ctrl) Loads the named OCX into the associated control frame.
character	name() Obtains the name attribute.
void	name(character _name) Sets the name attribute.
void	name(java.lang.String _name) Sets the name attribute.
void	setHeight(long height) Sets the new height of the widget or the screen display used in the current session, in pixels.
void	setHeight(NumberType height) Sets the new height of the widget or the screen display used in the current session, in pixels.
void	setLeft(long left) Sets the left of the widget or the screen display used in the current session, in pixels.
void	setLeft(NumberType left) Sets the left of the widget or the screen display used in the current session, in pixels.
void	setName(java.lang.String newName) Configure the legacy name of this COM object.
boolean	setProperty(java.lang.String prop, java.lang.Object newVal, java.lang.Object... indices) Sets a COM property for the COM object stored by the handle.
void	setTop(long top) Sets the new top of the widget or the screen display used in the current session, in pixels.
void	setTop(NumberType top) Sets the new top of the widget or the screen display used in the current session, in pixels.
void	setWidth(long width) Sets the width of the widget or the screen display used in the current session, in pixels.
void	setWidth(NumberType width) Sets the width of the widget or the screen display used in the current session, in pixels.

Methods inherited from class com.goldencode.p2j.comauto.ComObject

call, chainCall, checkParameters, deref, destroy, getComObjectClass, getComObjectInstance, getParentControlFrame, getParentProcedure, id, id, init, marshal, ref, setParentControlFrame, unknown, unmarshal, unmarshal, valid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Constructor Detail

ControlFrameComObjectImpl

public ControlFrameComObjectImpl()

Public default constructor.

Method Detail

setProperty

public boolean setProperty(java.lang.String prop,
                           java.lang.Object newVal,
                           java.lang.Object... indices)

Sets a COM property for the COM object stored by the handle.

Overrides:

setProperty in class ComObject

Parameters:

prop - The legacy property name. Case insensitive. If no property is found then a warning is displayed and method returns without altering the stored object.

newVal - The new value for the property. It must be of a compatible type with the property.

indices - A variable number of indices used to access this property's element.

Returns:

true if the property was set.

getProperty

public BaseDataType getProperty(java.lang.String prop,
                                java.lang.Object... indices)

Obtain a property value from the COM object stored in this handle.

Overrides:

getProperty in class ComObject

Parameters:

prop - The legacy name of the property. Case insensitive. If no property is found then a warning is displayed and method returns unknown value.

indices - A variable number of indices used to access this property's element.

Returns:

The value of the requested property or unknown on exceptions.

getActiveX

public comhandle getActiveX(java.lang.String axName)

Obtain a (com-)handle to a specific Java emulated ActiveX, if such instance exist. Theoretically a .wrx file loaded with loadControls() may contain multiple ActiveX-es. They are identified by their name as top-level properties of the ControlFrame widget.

Specified by:

getActiveX in interface ControlFrameComObject

Parameters:

axName - The ActiveX name.

Returns:

a comhandle to the requested activex object if such instance was loaded, otherwise null.

getName

public java.lang.String getName()

Obtain the legacy name of this COM object.

Overrides:

getName in class ComObject

Returns:

the legacy name of this COM object.

setName

public void setName(java.lang.String newName)

Configure the legacy name of this COM object.

Overrides:

setName in class ComObject

Parameters:

newName - the legacy name of this COM object.

getActivexName

public java.lang.String getActivexName()

Obtain the name of this ActiveX object.

Specified by:

getActivexName in class ComObject

Returns:

the name of this ActiveX object.

delete

public void delete()

Deleting objects of this type is illegal. They need to be deleted using the handle to its Control Frame handle, that can be obtained using WIDGET-HANDLE. This method will just throw error 5895.

Specified by:

delete in interface Deletable

Overrides:

delete in class ComObject

loadControls

public logical loadControls(java.lang.String wrxFile,
                            java.lang.String ctrl)

Loads the named OCX into the associated control frame.

Specified by:

loadControls in interface ControlFrameComObject

Parameters:

wrxFile - .wrx filename describing the OCX content to load. This parameter is ignored.

ctrl - Control frame name.

Returns:

true if operation was successful.

getControlName

public comhandle getControlName()

The component handle to an ActiveX control that has the specified design-time name (Control-Name) and that is loaded into the control-frame.

Specified by:

getControlName in interface ControlFrameComObject

Returns:

references to COM object properties and methods extend the syntax used for referencing widget attributes and methods.

getControls

public comhandle getControls()

Returns a control collection from this control frame.

Specified by:

getControls in interface ControlFrameComObject

Returns:

The collection of controls from this control frame.

getWidgetHandle

public handle getWidgetHandle()

Returns the handle of the control frame associated with the control-frame COM object.

Specified by:

getWidgetHandle in interface ControlFrameComObject

Returns:

The handle of the control frame associated with the control-frame COM object.

getWidth

public integer getWidth()

Obtain the width of the widget or the screen display used in the current session, in pixels.

Specified by:

getWidth in interface ControlFrameComObject

Returns:

The width of the widget or the screen display used in the current session.

setWidth

public void setWidth(long width)

Sets the width of the widget or the screen display used in the current session, in pixels.

Specified by:

setWidth in interface ControlFrameComObject

Parameters:

width - the new width of the widget or the screen display used in the current session.

setWidth

public void setWidth(NumberType width)

Sets the width of the widget or the screen display used in the current session, in pixels.

Specified by:

setWidth in interface ControlFrameComObject

Parameters:

width - the new width of the widget or the screen display used in the current session.

getHeight

public integer getHeight()

Obtain the height of the widget or the screen display used in the current session, in pixels.

Specified by:

getHeight in interface ControlFrameComObject

Returns:

the height of the widget or the screen display used in the current session.

setHeight

public void setHeight(long height)

Sets the new height of the widget or the screen display used in the current session, in pixels.

Specified by:

setHeight in interface ControlFrameComObject

Parameters:

height - the new height of the widget or the screen display used in the current session.

setHeight

public void setHeight(NumberType height)

Sets the new height of the widget or the screen display used in the current session, in pixels.

Specified by:

setHeight in interface ControlFrameComObject

Parameters:

height - the new height of the widget or the screen display used in the current session.

getLeft

public integer getLeft()

Obtain the left of the widget or the screen display used in the current session, in pixels.

Specified by:

getLeft in interface ControlFrameComObject

Returns:

The left of the widget or the screen display used in the current session.

setLeft

public void setLeft(long left)

Sets the left of the widget or the screen display used in the current session, in pixels.

Specified by:

setLeft in interface ControlFrameComObject

Parameters:

left - the new left of the widget or the screen display used in the current session.

setLeft

public void setLeft(NumberType left)

Sets the left of the widget or the screen display used in the current session, in pixels.

Specified by:

setLeft in interface ControlFrameComObject

Parameters:

left - the new left of the widget or the screen display used in the current session.

getTop

public integer getTop()

Obtain the top of the widget or the screen display used in the current session, in pixels.

Specified by:

getTop in interface ControlFrameComObject

Returns:

the top of the widget or the screen display used in the current session.

setTop

public void setTop(long top)

Sets the new top of the widget or the screen display used in the current session, in pixels.

Specified by:

setTop in interface ControlFrameComObject

Parameters:

top - the new top of the widget or the screen display used in the current session.

setTop

public void setTop(NumberType top)

Sets the new top of the widget or the screen display used in the current session, in pixels.

Specified by:

setTop in interface ControlFrameComObject

Parameters:

top - the new top of the widget or the screen display used in the current session.

getWidgetId

public integer getWidgetId()

Gets the WIDGET-ID writable attribute.

Specified by:

getWidgetId in interface ControlFrameComObject

Returns:

the widget id of the parent Control Fame.

getFrameHandle

public handle getFrameHandle()

Gets the FRAME attribute, which is the containing frame instance, as a handle.

Specified by:

getFrameHandle in interface ControlFrameComObject

Returns:

A handle to the frame that contains this Control Frame widget.

name

public character name()

Obtains the name attribute.

Specified by:

name in interface Nameable

Returns:

See above.

name

public void name(java.lang.String _name)

Sets the name attribute.

Specified by:

name in interface Nameable

Parameters:

_name - The new name to be set.

name

public void name(character _name)

Sets the name attribute.

Specified by:

name in interface Nameable

Parameters:

_name - The new name to be set.