LibreOffice 24.8.4 · com.sun.star.lib.uno.helper.PropertySetMixin

Modifier and Type	Class and Description
public static class	PropertySetMixin.BoundListeners A class used by clients of `PropertySetMixin` when implementing UNO interface type attribute setter functions.
private class	PropertySetMixin.Info
private static class	PropertySetMixin.PropertyData

Modifier and Type	Field and Description
private final String[]	absentOptional
private HashMap<String, ArrayList<com.sun.star.beans.XPropertyChangeListener>>	boundListeners
private final com.sun.star.uno.XComponentContext	context
private boolean	disposed
private final String[]	handleMap
private final com.sun.star.reflection.XIdlClass	idlClass
private final com.sun.star.uno.XInterface	object
private final Map<String, PropertySetMixin.PropertyData>	properties
private final Type	type
private HashMap<String, ArrayList<com.sun.star.beans.XVetoableChangeListener>>	vetoListeners

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	PropertySetMixin(com.sun.star.uno.XComponentContext the component context used by this instance; must not be null, and must supply the `com.sun.star.reflection.theCoreReflection` and `com.sun.star.reflection.theTypeDescriptionManager` singletons context, com.sun.star.uno.XInterface the client UNO object into which this instance is mixed in; must not be null, and must support the given `type` object, Type the UNO interface type whose attributes are mapped to properties; must not be null, and must represent a UNO interface type type, String[] a list of optional properties that are not present, and should thus not be visible via `com.sun.star.beans.XPropertySet.getPropertySetInfo`, `com.sun.star.beans.XPropertySet.addPropertyChangeListener`, `com.sun.star.beans.XPropertySet.removePropertyChangeListener`, `com.sun.star.beans.XPropertySet.addVetoableChangeListener`, and `com.sun.star.beans.XPropertySet.removeVetoableChangeListener`; null is treated the same as an empty list; if non-null, the given array must not be modified after it is passed to this constructor. For consistency reasons, the given `absentOptional` should only contain the names of attributes that represent optional properties that are not present (that is, the attribute getters and setters always throw a `com.sun.star.beans.UnknownPropertyException`), and should contain each such name only once. If an optional property is not present (that is, the corresponding attribute getter and setter always throw a `com.sun.star.beans.UnknownPropertyException`) but is not contained in the given `absentOptional`, then it will be visible via `com.sun.star.beans.XPropertySet.getPropertySetInfo` as a `com.sun.star.beans.Property` with a set `com.sun.star.beans.PropertyAttribute.OPTIONAL`. If the given `object` does not implement `com.sun.star.beans.XPropertySet`, then the given `absentOptional` is effectively ignored and can be null or empty. absentOptional) The constructor.

public

PropertySetMixin(com.sun.star.uno.XComponentContext

the component context used by this instance; must not be null, and must supply the com.sun.star.reflection.theCoreReflection and com.sun.star.reflection.theTypeDescriptionManager singletons

context, com.sun.star.uno.XInterface

the client UNO object into which this instance is mixed in; must not be null, and must support the given type

object, Type

the UNO interface type whose attributes are mapped to properties; must not be null, and must represent a UNO interface type

type, String[]

a list of optional properties that are not present, and should thus not be visible via com.sun.star.beans.XPropertySet.getPropertySetInfo, com.sun.star.beans.XPropertySet.addPropertyChangeListener, com.sun.star.beans.XPropertySet.removePropertyChangeListener, com.sun.star.beans.XPropertySet.addVetoableChangeListener, and com.sun.star.beans.XPropertySet.removeVetoableChangeListener; null is treated the same as an empty list; if non-null, the given array must not be modified after it is passed to this constructor. For consistency reasons, the given absentOptional should only contain the names of attributes that represent optional properties that are not present (that is, the attribute getters and setters always throw a com.sun.star.beans.UnknownPropertyException), and should contain each such name only once. If an optional property is not present (that is, the corresponding attribute getter and setter always throw a com.sun.star.beans.UnknownPropertyException) but is not contained in the given absentOptional, then it will be visible via com.sun.star.beans.XPropertySet.getPropertySetInfo as a com.sun.star.beans.Property with a set com.sun.star.beans.PropertyAttribute.OPTIONAL. If the given object does not implement com.sun.star.beans.XPropertySet, then the given absentOptional is effectively ignored and can be null or empty.

absentOptional)

The constructor.

Method Summary

Modifier and Type	Method and Description
public void	addPropertyChangeListener(String See com.sun.star.beans.XPropertySet propertyName, com.sun.star.beans.XPropertyChangeListener See com.sun.star.beans.XPropertySet listener) Implements `com.sun.star.beans.XPropertySet.addPropertyChangeListener`.
public void	addVetoableChangeListener(String See com.sun.star.beans.XPropertySet propertyName, com.sun.star.beans.XVetoableChangeListener See com.sun.star.beans.XPropertySet listener) Implements `com.sun.star.beans.XPropertySet.addVetoableChangeListener`.
private void	checkUnknown(String propertyName)
public void	dispose() Marks this instance as being disposed.
private PropertySetMixin.PropertyData	get(Object object, String propertyName)
public Object	Returns: See com.sun.star.beans.XFastPropertySet getFastPropertyValue(int See com.sun.star.beans.XFastPropertySet handle) Implements `com.sun.star.beans.XFastPropertySet.getFastPropertyValue`.
pack-priv Object	getProperty(String name, com.sun.star.beans.PropertyState[] state)
public com.sun.star.beans.XPropertySetInfo	Returns: See com.sun.star.beans.XPropertySet getPropertySetInfo() Implements `com.sun.star.beans.XPropertySet.getPropertySetInfo`.
public Object	Returns: See com.sun.star.beans.XPropertySet getPropertyValue(String See com.sun.star.beans.XPropertySet propertyName) Implements `com.sun.star.beans.XPropertySet.getPropertyValue`.
public com.sun.star.beans.PropertyValue[]	Returns: See com.sun.star.beans.XPropertyAccess getPropertyValues() Implements `com.sun.star.beans.XPropertyAccess.getPropertyValues`.
private com.sun.star.reflection.XIdlClass	getReflection(String typeName)
private void	initProperties(com.sun.star.reflection.XTypeDescription type, HashMap<String, PropertySetMixin.PropertyData> map, ArrayList<String> handleNames, HashSet<String> seen)
public void	prepareSet(String the name of the property (which is the same as the name of the attribute that is going to be set) propertyName, Object the property value corresponding to the old attribute value. This is only used as `com.sun.star.beans.PropertyChangeEvent.OldValue`, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines). If the attribute that is going to be set is neither bound nor constrained, or if `com.sun.star.beans.PropertyChangeEvent.OldValue` should not be set, `Any#VOID` can be used instead. oldValue, Object the property value corresponding to the new attribute value. This is only used as `com.sun.star.beans.PropertyChangeEvent.NewValue`, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines), unless the attribute that is going to be set is constrained. If the attribute that is going to be set is neither bound nor constrained, or if it is only bound but `com.sun.star.beans.PropertyChangeEvent.NewValue` should not be set, `Any#VOID` can be used instead. newValue, PropertySetMixin.BoundListeners a reference to a fresh `BoundListeners` instance (which has not been passed to this method before, and on which `BoundListeners#notifyListeners` has not yet been called); may only be null if the attribute that is going to be set is not bound bound) A method used by clients when implementing UNO interface type attribute setter functions.
public void	prepareSet(String the name of the property (which is the same as the name of the attribute that is going to be set) propertyName, PropertySetMixin.BoundListeners a reference to a fresh `BoundListeners` instance (which has not been passed to this method before, and on which `BoundListeners#notifyListeners` has not yet been called); may only be null if the attribute that is going to be set is not bound bound) A simplified version of `prepareSet(String, Object, Object, PropertySetMixin.BoundListeners)`.
public void	removePropertyChangeListener(String See com.sun.star.beans.XPropertySet propertyName, com.sun.star.beans.XPropertyChangeListener See com.sun.star.beans.XPropertySet listener) Implements `com.sun.star.beans.XPropertySet.removePropertyChangeListener`.
public void	removeVetoableChangeListener(String See com.sun.star.beans.XPropertySet propertyName, com.sun.star.beans.XVetoableChangeListener See com.sun.star.beans.XPropertySet listener) Implements `com.sun.star.beans.XPropertySet.removeVetoableChangeListener`.
private static com.sun.star.reflection.XTypeDescription	resolveTypedefs(com.sun.star.reflection.XTypeDescription type)
public void	setFastPropertyValue(int See com.sun.star.beans.XFastPropertySet handle, Object See com.sun.star.beans.XFastPropertySet value) Implements `com.sun.star.beans.XFastPropertySet.setFastPropertyValue`.
private void	setProperty(String name, Object value, boolean isAmbiguous, boolean isDefaulted, short illegalArgumentPosition)
public void	setPropertyValue(String See com.sun.star.beans.XPropertySet propertyName, Object See com.sun.star.beans.XPropertySet value) Implements `com.sun.star.beans.XPropertySet.setPropertyValue`.
public void	setPropertyValues(com.sun.star.beans.PropertyValue[] See com.sun.star.beans.XPropertyAccess props) Implements `com.sun.star.beans.XPropertyAccess.setPropertyValues`.
private String	translateHandle(int handle)
private Object	wrapValue(Object value, com.sun.star.reflection.XIdlClass type, boolean wrapAmbiguous, boolean isAmbiguous, boolean wrapDefaulted, boolean isDefaulted, boolean wrapOptional)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

absentOptional	back to summary
private final String[] absentOptional

boundListeners	back to summary
private HashMap<String, ArrayList<com.sun.star.beans.XPropertyChangeListener>> boundListeners

context	back to summary
private final com.sun.star.uno.XComponentContext context

disposed	back to summary
private boolean disposed

handleMap	back to summary
private final String[] handleMap

idlClass	back to summary
private final com.sun.star.reflection.XIdlClass idlClass

object	back to summary
private final com.sun.star.uno.XInterface object

properties	back to summary
private final Map<String, PropertySetMixin.PropertyData> properties

type	back to summary
private final Type type

vetoListeners	back to summary
private HashMap<String, ArrayList<com.sun.star.beans.XVetoableChangeListener>> vetoListeners

Constructor Detail

PropertySetMixin back to summary

PropertySetMixin	back to summary
public PropertySetMixin(com.sun.star.uno.XComponentContext context, com.sun.star.uno.XInterface object, Type type, String[] absentOptional) The constructor. Parameters context:com.sun.star.uno.XComponentContext the component context used by this instance; must not be null, and must supply the `com.sun.star.reflection.theCoreReflection` and `com.sun.star.reflection.theTypeDescriptionManager` singletons object:com.sun.star.uno.XInterface the client UNO object into which this instance is mixed in; must not be null, and must support the given `type` type:Type the UNO interface type whose attributes are mapped to properties; must not be null, and must represent a UNO interface type absentOptional:String[] a list of optional properties that are not present, and should thus not be visible via `com.sun.star.beans.XPropertySet.getPropertySetInfo`, `com.sun.star.beans.XPropertySet.addPropertyChangeListener`, `com.sun.star.beans.XPropertySet.removePropertyChangeListener`, `com.sun.star.beans.XPropertySet.addVetoableChangeListener`, and `com.sun.star.beans.XPropertySet.removeVetoableChangeListener`; null is treated the same as an empty list; if non-null, the given array must not be modified after it is passed to this constructor. For consistency reasons, the given `absentOptional` should only contain the names of attributes that represent optional properties that are not present (that is, the attribute getters and setters always throw a `com.sun.star.beans.UnknownPropertyException`), and should contain each such name only once. If an optional property is not present (that is, the corresponding attribute getter and setter always throw a `com.sun.star.beans.UnknownPropertyException`) but is not contained in the given `absentOptional`, then it will be visible via `com.sun.star.beans.XPropertySet.getPropertySetInfo` as a `com.sun.star.beans.Property` with a set `com.sun.star.beans.PropertyAttribute.OPTIONAL`. If the given `object` does not implement `com.sun.star.beans.XPropertySet`, then the given `absentOptional` is effectively ignored and can be null or empty.

public PropertySetMixin(com.sun.star.uno.XComponentContext context, com.sun.star.uno.XInterface object, Type type, String[] absentOptional)

The constructor.

Parameters

context:com.sun.star.uno.XComponentContext: the component context used by this instance; must not be null, and must supply the com.sun.star.reflection.theCoreReflection and com.sun.star.reflection.theTypeDescriptionManager singletons
object:com.sun.star.uno.XInterface: the client UNO object into which this instance is mixed in; must not be null, and must support the given type
type:Type: the UNO interface type whose attributes are mapped to properties; must not be null, and must represent a UNO interface type
absentOptional:String[]: a list of optional properties that are not present, and should thus not be visible via com.sun.star.beans.XPropertySet.getPropertySetInfo, com.sun.star.beans.XPropertySet.addPropertyChangeListener, com.sun.star.beans.XPropertySet.removePropertyChangeListener, com.sun.star.beans.XPropertySet.addVetoableChangeListener, and com.sun.star.beans.XPropertySet.removeVetoableChangeListener; null is treated the same as an empty list; if non-null, the given array must not be modified after it is passed to this constructor. For consistency reasons, the given absentOptional should only contain the names of attributes that represent optional properties that are not present (that is, the attribute getters and setters always throw a com.sun.star.beans.UnknownPropertyException), and should contain each such name only once. If an optional property is not present (that is, the corresponding attribute getter and setter always throw a com.sun.star.beans.UnknownPropertyException) but is not contained in the given absentOptional, then it will be visible via com.sun.star.beans.XPropertySet.getPropertySetInfo as a com.sun.star.beans.Property with a set com.sun.star.beans.PropertyAttribute.OPTIONAL. If the given object does not implement com.sun.star.beans.XPropertySet, then the given absentOptional is effectively ignored and can be null or empty.

Method Detail

addPropertyChangeListener back to summary

addPropertyChangeListener	back to summary
public void addPropertyChangeListener(String propertyName, com.sun.star.beans.XPropertyChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.addPropertyChangeListener`. If a listener is added more than once, it will receive all relevant notifications multiple times. Parameters propertyName:String See com.sun.star.beans.XPropertySet listener:com.sun.star.beans.XPropertyChangeListener See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public void addPropertyChangeListener(String propertyName, com.sun.star.beans.XPropertyChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.addPropertyChangeListener.

If a listener is added more than once, it will receive all relevant notifications multiple times.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet
listener:com.sun.star.beans.XPropertyChangeListener: See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

addVetoableChangeListener back to summary

addVetoableChangeListener	back to summary
public void addVetoableChangeListener(String propertyName, com.sun.star.beans.XVetoableChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.addVetoableChangeListener`. If a listener is added more than once, it will receive all relevant notifications multiple times. Parameters propertyName:String See com.sun.star.beans.XPropertySet listener:com.sun.star.beans.XVetoableChangeListener See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public void addVetoableChangeListener(String propertyName, com.sun.star.beans.XVetoableChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.addVetoableChangeListener.

If a listener is added more than once, it will receive all relevant notifications multiple times.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet
listener:com.sun.star.beans.XVetoableChangeListener: See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

checkUnknown	back to summary
private void checkUnknown(String propertyName) throws com.sun.star.beans.UnknownPropertyException

dispose back to summary

dispose	back to summary
public void dispose() Marks this instance as being disposed. See `com.sun.star.lang.XComponent` for the general concept of disposing UNO objects. On the first call to this method, all registered listeners (`com.sun.star.beans.XPropertyChangeListener`s and `com.sun.star.beans.XVetoableChangeListener`s) are notified of the disposing source. Any subsequent calls to this method are ignored.

public void dispose()

Marks this instance as being disposed.

See com.sun.star.lang.XComponent for the general concept of disposing UNO objects. On the first call to this method, all registered listeners (com.sun.star.beans.XPropertyChangeListeners and com.sun.star.beans.XVetoableChangeListeners) are notified of the disposing source. Any subsequent calls to this method are ignored.

get	back to summary
private PropertySetMixin.PropertyData get(Object object, String propertyName) throws com.sun.star.beans.UnknownPropertyException

getFastPropertyValue back to summary

getFastPropertyValue	back to summary
public Object getFastPropertyValue(int handle) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XFastPropertySet.getFastPropertyValue`. Parameters handle:int See com.sun.star.beans.XFastPropertySet Returns:Object See com.sun.star.beans.XFastPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XFastPropertySet WrappedTargetException: See com.sun.star.beans.XFastPropertySet

public Object getFastPropertyValue(int handle) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XFastPropertySet.getFastPropertyValue.

Parameters

handle:int: See com.sun.star.beans.XFastPropertySet

Returns:Object

See com.sun.star.beans.XFastPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XFastPropertySet
WrappedTargetException:: See com.sun.star.beans.XFastPropertySet

getProperty	back to summary
pack-priv Object getProperty(String name, com.sun.star.beans.PropertyState[] state) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

getPropertySetInfo back to summary

getPropertySetInfo	back to summary
public com.sun.star.beans.XPropertySetInfo getPropertySetInfo() Implements `com.sun.star.beans.XPropertySet.getPropertySetInfo`. Returns:com.sun.star.beans.XPropertySetInfo See com.sun.star.beans.XPropertySet

public com.sun.star.beans.XPropertySetInfo getPropertySetInfo()

Implements com.sun.star.beans.XPropertySet.getPropertySetInfo.

Returns:com.sun.star.beans.XPropertySetInfo: See com.sun.star.beans.XPropertySet

getPropertyValue back to summary

getPropertyValue	back to summary
public Object getPropertyValue(String propertyName) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.getPropertyValue`. Parameters propertyName:String See com.sun.star.beans.XPropertySet Returns:Object See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public Object getPropertyValue(String propertyName) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.getPropertyValue.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet

Returns:Object

See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

getPropertyValues back to summary

getPropertyValues	back to summary
public com.sun.star.beans.PropertyValue[] getPropertyValues() Implements `com.sun.star.beans.XPropertyAccess.getPropertyValues`. Returns:com.sun.star.beans.PropertyValue[] See com.sun.star.beans.XPropertyAccess

public com.sun.star.beans.PropertyValue[] getPropertyValues()

Implements com.sun.star.beans.XPropertyAccess.getPropertyValues.

Returns:com.sun.star.beans.PropertyValue[]: See com.sun.star.beans.XPropertyAccess

getReflection	back to summary
private com.sun.star.reflection.XIdlClass getReflection(String typeName)

initProperties	back to summary
private void initProperties(com.sun.star.reflection.XTypeDescription type, HashMap<String, PropertySetMixin.PropertyData> map, ArrayList<String> handleNames, HashSet<String> seen)

prepareSet back to summary

prepareSet	back to summary
public void prepareSet(String propertyName, Object oldValue, Object newValue, PropertySetMixin.BoundListeners bound) throws com.sun.star.beans.PropertyVetoException A method used by clients when implementing UNO interface type attribute setter functions. First, this method checks whether this instance has already been disposed (see `dispose`), and throws a `com.sun.star.beans.DisposedException` if applicable. For a constrained attribute (whose setter can explicitly raise `com.sun.star.beans.PropertyVetoException`), this method notifies any `com.sun.star.beans.XVetoableChangeListener`s. For a bound attribute, this method modifies the passed-in `bound` so that it can afterwards be used to notify any `com.sun.star.beans.XPropertyChangeListener`s. This method should be called before storing the new attribute value, and `bound.notifyListeners()` should be called exactly once after storing the new attribute value (in case the attribute is bound; otherwise, calling `bound.notifyListeners()` is ignored). Furthermore, `bound.notifyListeners()` and this method have to be called from the same thread. Parameters propertyName:String the name of the property (which is the same as the name of the attribute that is going to be set) oldValue:Object the property value corresponding to the old attribute value. This is only used as `com.sun.star.beans.PropertyChangeEvent.OldValue`, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines). If the attribute that is going to be set is neither bound nor constrained, or if `com.sun.star.beans.PropertyChangeEvent.OldValue` should not be set, `Any#VOID` can be used instead. newValue:Object the property value corresponding to the new attribute value. This is only used as `com.sun.star.beans.PropertyChangeEvent.NewValue`, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines), unless the attribute that is going to be set is constrained. If the attribute that is going to be set is neither bound nor constrained, or if it is only bound but `com.sun.star.beans.PropertyChangeEvent.NewValue` should not be set, `Any#VOID` can be used instead. bound:PropertySetMixin.BoundListeners a reference to a fresh `BoundListeners` instance (which has not been passed to this method before, and on which `BoundListeners#notifyListeners` has not yet been called); may only be null if the attribute that is going to be set is not bound Exceptions PropertyVetoException: if a vetoable listener throws it.

public void prepareSet(String propertyName, Object oldValue, Object newValue, PropertySetMixin.BoundListeners bound) throws com.sun.star.beans.PropertyVetoException

A method used by clients when implementing UNO interface type attribute setter functions.

First, this method checks whether this instance has already been disposed (see dispose), and throws a com.sun.star.beans.DisposedException if applicable. For a constrained attribute (whose setter can explicitly raise com.sun.star.beans.PropertyVetoException), this method notifies any com.sun.star.beans.XVetoableChangeListeners. For a bound attribute, this method modifies the passed-in bound so that it can afterwards be used to notify any com.sun.star.beans.XPropertyChangeListeners. This method should be called before storing the new attribute value, and bound.notifyListeners() should be called exactly once after storing the new attribute value (in case the attribute is bound; otherwise, calling bound.notifyListeners() is ignored). Furthermore, bound.notifyListeners() and this method have to be called from the same thread.

Parameters

propertyName:String: the name of the property (which is the same as the name of the attribute that is going to be set)
oldValue:Object: the property value corresponding to the old attribute value. This is only used as com.sun.star.beans.PropertyChangeEvent.OldValue, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines). If the attribute that is going to be set is neither bound nor constrained, or if com.sun.star.beans.PropertyChangeEvent.OldValue should not be set, Any#VOID can be used instead.
newValue:Object: the property value corresponding to the new attribute value. This is only used as com.sun.star.beans.PropertyChangeEvent.NewValue, which is rather useless, anyway (see “Using the Observer Pattern” in OpenOffice.org Coding Guidelines), unless the attribute that is going to be set is constrained. If the attribute that is going to be set is neither bound nor constrained, or if it is only bound but com.sun.star.beans.PropertyChangeEvent.NewValue should not be set, Any#VOID can be used instead.
bound:PropertySetMixin.BoundListeners: a reference to a fresh BoundListeners instance (which has not been passed to this method before, and on which BoundListeners#notifyListeners has not yet been called); may only be null if the attribute that is going to be set is not bound

Exceptions

PropertyVetoException:: if a vetoable listener throws it.

prepareSet back to summary

prepareSet	back to summary
public void prepareSet(String propertyName, PropertySetMixin.BoundListeners bound) A simplified version of `prepareSet(String, Object, Object, PropertySetMixin.BoundListeners)`. This method is useful for attributes that are not constrained. Parameters propertyName:String the name of the property (which is the same as the name of the attribute that is going to be set) bound:PropertySetMixin.BoundListeners a reference to a fresh `BoundListeners` instance (which has not been passed to this method before, and on which `BoundListeners#notifyListeners` has not yet been called); may only be null if the attribute that is going to be set is not bound

public void prepareSet(String propertyName, PropertySetMixin.BoundListeners bound)

A simplified version of prepareSet(String, Object, Object, PropertySetMixin.BoundListeners).

This method is useful for attributes that are not constrained.

Parameters

propertyName:String: the name of the property (which is the same as the name of the attribute that is going to be set)
bound:PropertySetMixin.BoundListeners: a reference to a fresh BoundListeners instance (which has not been passed to this method before, and on which BoundListeners#notifyListeners has not yet been called); may only be null if the attribute that is going to be set is not bound

removePropertyChangeListener back to summary

removePropertyChangeListener	back to summary
public void removePropertyChangeListener(String propertyName, com.sun.star.beans.XPropertyChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.removePropertyChangeListener`. Parameters propertyName:String See com.sun.star.beans.XPropertySet listener:com.sun.star.beans.XPropertyChangeListener See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public void removePropertyChangeListener(String propertyName, com.sun.star.beans.XPropertyChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.removePropertyChangeListener.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet
listener:com.sun.star.beans.XPropertyChangeListener: See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

removeVetoableChangeListener back to summary

removeVetoableChangeListener	back to summary
public void removeVetoableChangeListener(String propertyName, com.sun.star.beans.XVetoableChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.removeVetoableChangeListener`. Parameters propertyName:String See com.sun.star.beans.XPropertySet listener:com.sun.star.beans.XVetoableChangeListener See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public void removeVetoableChangeListener(String propertyName, com.sun.star.beans.XVetoableChangeListener listener) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.removeVetoableChangeListener.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet
listener:com.sun.star.beans.XVetoableChangeListener: See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

resolveTypedefs	back to summary
private static com.sun.star.reflection.XTypeDescription resolveTypedefs(com.sun.star.reflection.XTypeDescription type)

setFastPropertyValue back to summary

setFastPropertyValue	back to summary
public void setFastPropertyValue(int handle, Object value) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XFastPropertySet.setFastPropertyValue`. Parameters handle:int See com.sun.star.beans.XFastPropertySet value:Object See com.sun.star.beans.XFastPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XFastPropertySet PropertyVetoException: See com.sun.star.beans.XFastPropertySet WrappedTargetException: See com.sun.star.beans.XFastPropertySet

public void setFastPropertyValue(int handle, Object value) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XFastPropertySet.setFastPropertyValue.

Parameters

handle:int: See com.sun.star.beans.XFastPropertySet
value:Object: See com.sun.star.beans.XFastPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XFastPropertySet
PropertyVetoException:: See com.sun.star.beans.XFastPropertySet
WrappedTargetException:: See com.sun.star.beans.XFastPropertySet

setProperty	back to summary
private void setProperty(String name, Object value, boolean isAmbiguous, boolean isDefaulted, short illegalArgumentPosition) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException

setPropertyValue back to summary

setPropertyValue	back to summary
public void setPropertyValue(String propertyName, Object value) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertySet.setPropertyValue`. Parameters propertyName:String See com.sun.star.beans.XPropertySet value:Object See com.sun.star.beans.XPropertySet Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertySet PropertyVetoException: See com.sun.star.beans.XPropertySet WrappedTargetException: See com.sun.star.beans.XPropertySet

public void setPropertyValue(String propertyName, Object value) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertySet.setPropertyValue.

Parameters

propertyName:String: See com.sun.star.beans.XPropertySet
value:Object: See com.sun.star.beans.XPropertySet

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertySet
PropertyVetoException:: See com.sun.star.beans.XPropertySet
WrappedTargetException:: See com.sun.star.beans.XPropertySet

setPropertyValues back to summary

setPropertyValues	back to summary
public void setPropertyValues(com.sun.star.beans.PropertyValue[] props) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException Implements `com.sun.star.beans.XPropertyAccess.setPropertyValues`. Parameters props:com.sun.star.beans.PropertyValue[] See com.sun.star.beans.XPropertyAccess Exceptions UnknownPropertyException: See com.sun.star.beans.XPropertyAccess PropertyVetoException: See com.sun.star.beans.XPropertyAccess WrappedTargetException: See com.sun.star.beans.XPropertyAccess

public void setPropertyValues(com.sun.star.beans.PropertyValue[] props) throws com.sun.star.beans.UnknownPropertyException, com.sun.star.beans.PropertyVetoException, com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException

Implements com.sun.star.beans.XPropertyAccess.setPropertyValues.

Parameters

props:com.sun.star.beans.PropertyValue[]: See com.sun.star.beans.XPropertyAccess

Exceptions

UnknownPropertyException:: See com.sun.star.beans.XPropertyAccess
PropertyVetoException:: See com.sun.star.beans.XPropertyAccess
WrappedTargetException:: See com.sun.star.beans.XPropertyAccess

translateHandle	back to summary
private String translateHandle(int handle) throws com.sun.star.beans.UnknownPropertyException

wrapValue	back to summary
private Object wrapValue(Object value, com.sun.star.reflection.XIdlClass type, boolean wrapAmbiguous, boolean isAmbiguous, boolean wrapDefaulted, boolean isDefaulted, boolean wrapOptional)

Modifier and Type	Field and Description
private com.sun.star.beans.PropertyChangeEvent	event
private ArrayList<com.sun.star.beans.XPropertyChangeListener>	specificListeners
private ArrayList<com.sun.star.beans.XPropertyChangeListener>	unspecificListeners

Modifier and Type	Method and Description
public com.sun.star.beans.Property[]	getProperties()
public com.sun.star.beans.Property	getPropertyByName(String name)
public boolean	hasPropertyByName(String name)

public final Class PropertySetMixin

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class PropertySetMixin.BoundListeners

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PropertySetMixin.Info

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PropertySetMixin.PropertyData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Modifier and Type	Field and Description
public final boolean	present
public final com.sun.star.beans.Property	property