specifies a user interface element factory that can create and initialize
user interface elements.
User interface element factories must be registered at a
UIElementFactoryManager service to provide access to itself.
Currently the following user interface element types are defined:
creates a new instances of a specific user interface element.
Parameter ResourceURL
specifies which unique user interface element should be created
by the factory. A resourcce URL must meet the following syntax:
"private:resource/$type/$name. It is only allowed to use ascii
characters for type and name. This argument must not be empty to
have a working user interface element instance.The implementation
can throw an
::com::sun::star::container::NoSuchElementException
if it doesn't know how to create the request user interface
element.
Parameter Args
The following arguments are supported:
Frame
specifies the ::com::sun::star::frame::XFrame
instance to which the user interface element belongs to. To
create a configurable user interface element the frame
instance must contain a visible component. Otherwise it is
not possible to determine the correct user interface
configuration manager. This argument is mandatory to
have a working configurable user interface element instance.
ParentWindow
specifies a parent window to use for the window(s) representing
the UI element. Depending on the concrete UI element type, this parameter
might be required or ignored by an implementation.
Persistent specifies if changes to a configurable
user interface element should be persistent. This is an
optional argument. The default value is true.
An implementation is responsible to initialize every newly created user
interface element if the necessary properties are provided. Especially
it must connect a configurable user interface element to the correct user
interface configuration manager. Without this connection the configurable
user interface element cannot retrieve its structure data and changes to
the user interface element structure won't be persistent. It is up to the
implementation to throw an
::com::sun::star::lang::IllegalArgumentException
if it cannot create a user interface element with the provided arguments.
