Difference between revisions of "NL/Documentation/BASIC Guide/Interface Overview"

From Apache OpenOffice Wiki
Jump to: navigation, search
(Interface com.sun.star.container.XNameContainer)
(Index-Based Access to Subordinate Objects)
Line 103: Line 103:
 
De regel <tt>insertByName</tt> voegt het opmaakprofiel <tt>NieuwOpmaakprofiel</tt> in onder dezelfde naam in het object <tt>AlineaOpmaakprofielen</tt>. De regel <tt>replaceByName</tt> verandert het object achter <tt>GewijzigdOpmaakprofiel</tt> in <tt>NieuwOpmaakprofiel</tt>. Tenslotteverwijdert de aanroep <tt>removeByName</tt> het object achter <tt>OudeOpmaakprofiel</tt> uit <tt>AlineaOpmaakprofielen</tt>.
 
De regel <tt>insertByName</tt> voegt het opmaakprofiel <tt>NieuwOpmaakprofiel</tt> in onder dezelfde naam in het object <tt>AlineaOpmaakprofielen</tt>. De regel <tt>replaceByName</tt> verandert het object achter <tt>GewijzigdOpmaakprofiel</tt> in <tt>NieuwOpmaakprofiel</tt>. Tenslotteverwijdert de aanroep <tt>removeByName</tt> het object achter <tt>OudeOpmaakprofiel</tt> uit <tt>AlineaOpmaakprofielen</tt>.
  
== Index-Based Access to Subordinate Objects ==
+
== Op index gebaseerde toegang tot onderliggende objecten ==
  
The <tt>XIndexAccess</tt> and <tt>XIndexContainer</tt> interfaces are used in objects which contain subordinate objects and which can be addressed using an index.  
+
De interfaces <tt>XIndexAccess</tt> en <tt>XIndexContainer</tt> worden gebruikt in objecten die onderliggende objecten bevatten en die benaderd kunnen worden via een index.
  
<tt>XIndexAccess</tt> provides the methods for accessing individual objects. <tt>XIndexContainer</tt> provides methods for inserting and removing elements.
+
<tt>XIndexAccess</tt> verschaft de methoden om toegang te krijgen tot individuele objecten. <tt>XIndexContainer</tt> verschaft methoden voor het invoegen en verwijderen van elementen.
  
=== <tt>com.sun.star.container.XIndexAccess</tt> Interface ===
+
=== Interface <tt>com.sun.star.container.XIndexAccess</tt> ===
  
<tt>XIndexAccess</tt> provides the <tt>getByIndex</tt> and <tt>getCount</tt> methods for calling the subordinate objects. <tt>getByIndex</tt> provides an object with a particular index. <tt>getCount</tt> returns how many objects are available.  
+
<tt>XIndexAccess</tt> verschaft de methoden <tt>getByIndex</tt> en <tt>getCount</tt> voor het aanroepen van de onderliggende objecten. <tt>getByIndex</tt> verschaft een object door middel van een bepaalde index. <tt>getCount</tt> geeft weer hoeveel objecten beschikbaar zijn.
  
 
<source lang="oobas">
 
<source lang="oobas">
Dim Sheets As Object
+
Dim Bladen As Object
Dim Sheet As Object
+
Dim Blad As Object
 
Dim I As Integer
 
Dim I As Integer
  
Sheets = Spreadsheet.Sheets
+
Bladen = Spreadsheet.Sheets
  
For I = 0 to Sheets.getCount() - 1
+
For I = 0 to Bladen.getCount() - 1
   Sheet = Sheets.getByIndex(I)
+
   Blad = Bladen.getByIndex(I)
   ' Editing sheet
+
   ' Blad bewerken
 
Next I
 
Next I
 
</source>
 
</source>
  
The example shows a loop that runs through all sheet elements one after another and saves a reference to each in the <tt>Sheet</tt> object variable. When working with the indexes, note that <tt>getCount</tt> returns the number of elements. The elements in <tt>getByIndex</tt> however are numbered beginning with 0. The counting variable of the loop therefore runs from 0 to <tt>getCount()-1</tt>.
+
Het voorbeeld toont een lus die één voor één door alle elementen van het werkblad gaat en een verwijzing voor elk bewaart in de object-variabele <tt>Blad</tt> . Bij Merk op dat, bij het werken met de indexen, <tt>getCount</tt> het aantal elementen teruggeeft. Echter, de elementen in <tt>getByIndex</tt> zijn genummerd beginnend met 0. De variabele voor het tellen van de lus loopt daarom van 0 tot en met <tt>getCount()-1</tt>.
  
=== <tt>com.sun.star.container.XIndexContainer</tt> Interface ===
+
=== Interface <tt>com.sun.star.container.XIndexContainer</tt> ===
  
The <tt>XIndexContainer</tt> interface provides the <tt>insertByIndex</tt> and <tt>removeByIndex</tt> functions. The parameters are structured in the same way as the corresponding functions in <tt>XNameContainer</tt>.
+
De interface <tt>XIndexContainer</tt> verschaft de functies <tt>insertByIndex</tt> en <tt>removeByIndex</tt>. De parameters worden op dezelfde wijze gestructureerd als de overeenkomende functies in <tt>XNameContainer</tt>.
  
 
== Iterative Access to Subordinate Objects ==
 
== Iterative Access to Subordinate Objects ==

Revision as of 14:26, 28 January 2013

Book.png


Sommige interfaces van Apache OpenOffice kunnen worden gevonden in vele delen van de Apache OpenOffice API. Zij definiëren reeksen van methoden voor abstracte taken welke kunnen worden toegepast voor verschillende problemen. Hier vindt u een overzicht van de meest voorkomende van deze interfaces.

De herkomst van de objecten wordt op een later punt in deze gids verklaard. Op dit punt worden slechts enkele van de abstracte aspecten van objecten, waarvoor de Apache OpenOffice API sommige centrale interfaces verschaft, besproken.

Context-afhankelijke objecten maken

De Apache OpenOffice API verschaft twee opties voor het creëren van objecten. Eén kan worden gevonden in de functie createUnoService, vermeld aan het begin van dit hoofdstuk. createUnoService maakt een object dat universeel kan worden gebruikt. Zulke objecten en services zijn ook bekend als context-onafhankelijke services.

In aanvulling op de context-onafhankelijke services, zijn er ook context-afhankelijke services waarvan de objecten alleen handig zijn in samenhang met een ander object. Een tekenobject voor een werkbladdocument kan daarom bijvoorbeeld alleen bestaan in samenhang met dat ene document.

Interface com.sun.star.lang.XMultiServiceFactory

Context-afhankelijke objecten worden normaal gesproken gemaakt door middel van een objectmethode, waar het object van afhankelijk is. De methode createInstance, welke wordt gedefinieerd in de interface XMultiServiceFactory, wordt speciaal gebruikt in de objecten document.

Het tekenobject kan bijvoorbeeld als volgt worden gemaakt door gebruik van een object werkbladdocument:

Dim RechthoekVorm As Object
RechthoekVorm = _
  Spreadsheet.createInstance("com.sun.star.drawing.RectangleShape")

Een sjabloon voor een alinea in een tekstdocument wordt op dezelfde manier gemaakt:

Dim Opmaakprofiel as Object
Opmaakprofiel = Textdocument.createInstance("com.sun.star.style.ParagraphStyle")

Benoemde toegang tot onderliggende objecten

De interfaces XNameAccess en XNameContainer worden gebruikt in objecten die onderliggende objecten bevatten, welke kunnen worden benaderd door een naam in een natuurlijke taal.

Terwijl XNameAccess toegang verleent tot de individuele objecten, neemt XNameContainer de invoeging, wijziging en verwijdering van elementen op zich.

Interface com.sun.star.container.XNameAccess

Een voorbeeld van het gebruik van XNameAccess wordt verschaft door het object sheets van een werkbladdocument. Het combineert alle bladen binnen het werkbladdocument. De individuele bladen worden benaderd vanuit het object Bladen met behulp van de methode getByName vanuit XNameAccess:

Dim Bladen As Object
Dim Blad As Object
 
Bladen = Spreadsheet.Sheets
Blad = Bladen.getByName("Blad1")

De methode getElementNames verschaft een overzicht van de namen van alle elementen. Als resultaat geeft het een gegevensveld weer waarin de namen staan. Het volgende voorbeeld toont hoe alle namen van elementen van een werkbladdocument daardoor kunnen worden bepaald en weergegeven in een lus:

Dim Bladen As Object
Dim BladNamen
Dim I As Integer
 
Bladen = Spreadsheet.Sheets
BladNamen = Bladen.getElementNames
 
For I=LBound(BladNamen) To UBound(BladNamen)
  MsgBox BladNamen(I)
Next I

De methode hasByName van de interface XNameAccess onthult of een onderliggend object met een bepaalde naam bestaat binnen het basis-object. Het volgende voorbeeld geeft daarom een bericht weer dat de gebruiker informeert of het object Spreadsheet een blad bevat met de naam Blad1.

Dim Bladen As Object
 
Bladen = Spreadsheet.Sheets
If Bladen.HasByName("Blad1") Then
  MsgBox "Blad1 beschikbaar"
Else
  MsgBox "Blad1 niet beschikbaar"
End If

Interface com.sun.star.container.XNameContainer

De interface XNameContainer behandelt het invoegen, verwijderen en wijzigen van onderliggende elementen in een basisobject. De verantwoordelijke functies zijn insertByName, removeByName en replaceByName.

Het volgende is een praktisch voorbeeld hiervan. Het roept een tekstdocument aan, dat een object StyleFamilies bevat en gebruikt die om op zijn beurt de sjablonen voor alinea's (Alinea-opmaakprofielen) van het document beschikbaar te maken.

Dim Opmaakprofielen As Object
Dim Alineaopmaakprofielen As Object
Dim NieuwOpmaakprofiel As Object   
 
Opmaakprofielen = Textdoc.StyleFamilies
Alineaopmaakprofielen = Opmaakprofielen.getByName("Alineaopmaakprofielen")
Alineaopmaakprofielen.insertByName("NieuwOpmaakprofiel", NieuwOpmaakprofiel)      
Alineaopmaakprofielen.replaceByName("GewijzigdOpmaakprofiel", NieuwOpmaakprofiel)   
Alineaopmaakprofielen.removeByName("OudeOpmaakprofiel")

De regel insertByName voegt het opmaakprofiel NieuwOpmaakprofiel in onder dezelfde naam in het object AlineaOpmaakprofielen. De regel replaceByName verandert het object achter GewijzigdOpmaakprofiel in NieuwOpmaakprofiel. Tenslotteverwijdert de aanroep removeByName het object achter OudeOpmaakprofiel uit AlineaOpmaakprofielen.

Op index gebaseerde toegang tot onderliggende objecten

De interfaces XIndexAccess en XIndexContainer worden gebruikt in objecten die onderliggende objecten bevatten en die benaderd kunnen worden via een index.

XIndexAccess verschaft de methoden om toegang te krijgen tot individuele objecten. XIndexContainer verschaft methoden voor het invoegen en verwijderen van elementen.

Interface com.sun.star.container.XIndexAccess

XIndexAccess verschaft de methoden getByIndex en getCount voor het aanroepen van de onderliggende objecten. getByIndex verschaft een object door middel van een bepaalde index. getCount geeft weer hoeveel objecten beschikbaar zijn.

Dim Bladen As Object
Dim Blad As Object
Dim I As Integer
 
Bladen = Spreadsheet.Sheets
 
For I = 0 to Bladen.getCount() - 1
  Blad = Bladen.getByIndex(I)
  ' Blad bewerken
Next I

Het voorbeeld toont een lus die één voor één door alle elementen van het werkblad gaat en een verwijzing voor elk bewaart in de object-variabele Blad . Bij Merk op dat, bij het werken met de indexen, getCount het aantal elementen teruggeeft. Echter, de elementen in getByIndex zijn genummerd beginnend met 0. De variabele voor het tellen van de lus loopt daarom van 0 tot en met getCount()-1.

Interface com.sun.star.container.XIndexContainer

De interface XIndexContainer verschaft de functies insertByIndex en removeByIndex. De parameters worden op dezelfde wijze gestructureerd als de overeenkomende functies in XNameContainer.

Iterative Access to Subordinate Objects

In some instances, an object may contain a list of subordinate objects that cannot be addressed by either a name or an index. In these situations, the XEnumeration and XenumerationAccess interfaces are appropriate. They provide a mechanism through which all subordinate elements of an objects can be passed, step by step, without having to use direct addressing.

com.sun.star.container.XEnumeration and XenumerationAccess Interfaces

The basic object must provide the XEnumerationAccess interface, which contains only a createEnumeration method. This returns an auxiliary object, which in turn provides the XEnumeration interface with the hasMoreElements and nextElement methods. Through these, you then have access to the subordinate objects.

The following example steps through all the paragraphs of a text:

Dim ParagraphEnumeration As Object
Dim Paragraph As Object
 
ParagraphEnumeration = Textdoc.Text.createEnumeration
 
While ParagraphEnumeration.hasMoreElements()
  Paragraph = ParagraphEnumeration.nextElement()
Wend

The example first creates a ParagraphEnumeration auxiliary object. This gradually returns the individual paragraphs of the text in a loop. The loop is terminated as soon as the hasMoreElements method returns the False value, signaling that the end of the text has been reached.


Content on this page is licensed under the Public Documentation License (PDL).
Personal tools