Content for OpenOffice.org version 3.3.
:: com :: sun :: star :: lang ::
|
| interface XConnectionPoint |
|
- Description
- supports connection points for connectable objects.
Connectable objects support the following features:
- outgoing interfaces, such as event sets;
- the ability to enumerate the types of the outgoing interfaces;
- the ability to connect and disconnect sinks to the object
for those outgoing types;
- the ability to enumerate the connections that exist to a
particular outgoing interface.
When to Implement?
To create a connectable object, you need to implement objects
that provide two related interfaces:
The XConnectionPointContainer interface is implemented
on the connectable object to indicate the existence of the outgoing
interfaces. It provides a sequence of sub-objects. It also provides
access to all the connection point sub-objects, each of which
implements the XConnectionPoint interface. The
XConnectionPoint interface provides a sequence of
sub-objects.
Each connection point is a separate sub-object to avoid circular
reference counting problems. A connection point controls how many
connections (one or more) it will allow in its implementation of
advise().
When to use?
A client can use the XConnectionPointContainer interface:
- to get a sequence of connection points for each outgoing type.
- to obtain access to connection point sub-objects with the
XConnectionPoint interface for each
outgoing type. Through the XConnectionPoint interface,
a client starts or terminates an advisory loop with the
connectable object and the client's own sink. The
client can also use the XConnectionPoint
interface to get a sequence of the connections that it
knows about.
- See also
- XConnectionPointContainer
|
| Methods' Details |
| getConnectionType
|
| getConnectionPointContainer
|
advise
- Description
- creates a connection between a connection point and a
client's sink, where the sink implements the outgoing interface
supported by this connection point.
A few add...Listener methods need additional parameters
to add listeners or throw exceptions. One of these methods is
::com::sun::star::beans::XPropertySet::addPropertyChangeListener.
We ignore the problem in this interface. A solution must be provided
in an additional XConnectionPoint interface.
- Parameter xListener
- specifies the listener interface on the client's advise sink.
The client's sink receives outgoing calls from the
connection point container.
- Throws
- ListenerExistException
if it is a unicast broadcaster and a listener is already set.
- Throws
- InvalidListenerException
if the listener does not supply the needed interfaces.
- See also
- ::com::sun::star::beans::XPropertySet::addPropertyChangeListener
|
|
unadvise
| void |
| unadvise( |
[in] ::com::sun::star::uno::XInterface |
xListener ); |
- Description
- terminates a notification previously set up with advise.
A few remove...Listener methods need additional
parameters to add listeners or throw exceptions. One of these methods
is ::com::sun::star::beans::XPropertySet::removePropertyChangeListener.
We ignore the problem in this interface. A solution must be
provided in an additional XConnectionPoint interface.
- Parameter listener
- specifies the listener interface on the client's advise sink.
- See also
- ::com::sun::star::beans::XPropertySet::removePropertyChangeListener
|
|
getConnections
- Returns
- a sequence of all currently advised connections.
|
|
Top of Page
Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.