Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

service PackageFolderContent
Description
A PCP Folder is a container for other PCP Folders and PCP Streams.
See also
PackageContentProvider, PackageStreamContent

Exported Interfaces - Summary
::com::sun::star::lang::XComponent

This interface is implemented according to the specification of service Content.

XContent

This interface is implemented according to the specification of service Content.

XCommandProcessor

This interface is implemented according to the specification of service Content. (details)

XCommandProcessor2

is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier. (details)

::com::sun::star::beans::XPropertiesChangeNotifier

This interface is implemented according to the specification of service Content.

::com::sun::star::beans::XPropertyContainer

This interface is implemented according to the specification of service Content.

::com::sun::star::beans::XPropertySetInfoChangeNotifier

This interface is implemented according to the specification of service Content.

XCommandInfoChangeNotifier

This interface is implemented according to the specification of service Content.

::com::sun::star::container::XChild

This interface is implemented according to the specification of service Content.

XContentCreator

This interface is implemented according to the specification of service Content. (details)

Exported Interfaces - Details
::com::sun::star::lang::XComponent
Description
This interface is implemented according to the specification of service Content.
XContent
Description
This interface is implemented according to the specification of service Content.
XCommandProcessor
Description
This interface is implemented according to the specification of service Content.

Supported Commands

  • getCommandInfo
  • getPropertySetInfo
  • getPropertyValues
  • setPropertyValues
  • insert ( makes a newly created folder persistent )
  • delete
  • open
  • transfer ( only transfers from PCP Folders/PCP Streams to other PCP folders. It does not handle contents with a URL scheme other then the PCP-URL-scheme. )
  • flush ( a command introduced by the PCP Folder. It takes a void-argument and returns void. This command is used to write unsaved changes to the underlying package file. Note that the current implementation of PCP contents never flushes automatically! Operations which require a flush to get persistent, are: "setPropertyValues( < any_non_read_only_property > ) ", "delete", "insert" )
Supported Properties
  • string ContentType ( read-only, always "application/vnd.sun.star.pkg-folder" )
  • boolean IsDocument ( read-only, always false )
  • boolean IsFolder ( read-only, always true )
  • string MediaType
  • string Title

XCommandProcessor2
Usage Restrictions
optional
Description
is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier.

Where many existing Content implementations do not (yet), every new implementation should support this interface.

::com::sun::star::beans::XPropertiesChangeNotifier
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::beans::XPropertyContainer
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::beans::XPropertySetInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content.
XCommandInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content.
::com::sun::star::container::XChild
Description
This interface is implemented according to the specification of service Content.
XContentCreator
Description
This interface is implemented according to the specification of service Content.

A PCP Folder can create other PCP Folders and PCP Streams. To create a new child of a PCP Folder:

  1. Let the parent folder create a new content by calling XContentCreator::createNewContent on it. The content type to use for new folders is "application/vnd.sun.star.pkg-folder". To create a new PCP Stream, use the type "application/vnd.sun.star.pkg-stream".
  2. Set a title at the new folder / stream. ( Let the new child execute the command "setPropertyValues", which sets at least the property "Title" to a non-empty value ).
  3. Let the new child ( not the parent! ) execute the command "insert". This will commit the creation process. For streams, you need to supply the implementation of an ::com::sun::star::io::XInputStream with the command's parameters, that provides access to the stream data.

Another, more convenient way for creating streams is simply to assemble the URL for the new content ( last part of the path will become the title of the new stream ) and to obtain a Content object for that URL from the UCB. Then let the content execute the command "insert". The command will fail, if you set the command's parameter InsertCommandArgument::ReplaceExisting" to false and there is already a stream with the title given by the content's URL.


 
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.