Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

:: com :: sun :: star :: form :: component ::
service ImageButton
Description This service specifies the control model for a clickable button which is represented by an image. The image to be displayed is determined by ::com::sun::star::awt::UnoControlImageControlModel::ImageURL property specifies the URL of an image to be displayed. See also CommandButton

Included Services
::com::sun::star::awt::UnoControlImageControlModel | specifies the standard model of an ::com::sun::star::awt::UnoControlImageControl .
::com::sun::star::form::FormControlModel | specifies a control model within a form.

Exported Interfaces
::com::sun::star::form::XImageProducerSupplier | Description supplies the caller with an ::com::sun::star::awt::XImageProducer . Other components can register as ::com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed. Whenever the ::com::sun::star::awt::UnoControlImageControlModel::ImageURL property is changed, the model loads the specified image, and sets it as image source at its ::com::sun::star::awt::XImageProducer . Then, all ::com::sun::star::awt::XImageConsumer s are notified and supplied with the binary data of the image. Usually, controls acting for an ImageButton model are consumers, and use the data stream to display the image

Properties' Summary
ButtonType | describes the action to be executed by the button when pressed.
TargetFrame | describes the frame, where to open the document specified by the TargetURL.
TargetURL | specifies the URL, which should be opened if the button was clicked.

Properties' Details
ButtonType
::com::sun::star::form::FormButtonType ButtonType; Description describes the action to be executed by the button when pressed.
TargetFrame
string TargetFrame; Description describes the frame, where to open the document specified by the TargetURL. This property is evaluated if the button is of type URL. As always, there is a number of target names which have a special meaning, and force a special ::com::sun::star::frame::Frame to be used.
TargetURL
string TargetURL; Description specifies the URL, which should be opened if the button was clicked. This property is evaluated if the button is of type URL. See also ::com::sun::star::form::FormButtonType

Top of Page

Copyright © 2003 Sun Microsystems, Inc.