Παράδειγμα - Εργαλείο διαχείρισης αρχείων readme

Εισαγωγή

Η λειτουργία επεξεργασίας αρχείων readme δείχνεί τον τρόπο καθορισμού των δικών σας σημείων επέκτασης για χρήση από άλλες πρόσθετες λειτουργίες. Δείχνει επίσης τον τρόπο δημιουργίας επεκτάσεων για καταχωρήσεις αναδυόμενων μενού πόρου, οδηγούς νέου πόρου, λειτουργίες επεξεργασίας αρχείου σε μια επέκταση (.readme), μια προσαρμοσμένη προβολή και σελίδες ιδιοτήτων.

Εκτέλεση του παραδείγματος

Για την εκκίνηση χρήσης αυτού του παραδείγματος, δημιουργήστε ένα αρχείο με την επέκταση .readme χρησιμοποιώντας τον οδηγό δημιουργίας αρχείου ή χρησιμοποιώντας τον οδηγό δημιουργίας παραδείγματος. Μπορείτε να δείτε την πρόσθετη προβολή που παρέχεται από αυτό το παράδειγμα επιλέγοντας "Παράθυρο > Εμφάνιση προβολής > Άλλο" και αναπτύξτε την ενότητα "Αρχείο readme". Μπορείτε να δείτε την ενέργεια προβολής πατώντας το εικονίδιο αρχείου readme στην προβολή "Πλοήγηση".

Δημιουργία νέου αρχείου readme

Δημιουργήστε ένα νέο αρχείο με την επέκταση αρχείου .readme.  Από το μενού "Αρχείο", επιλέξτε "Δημιουργία" και κατόπιν "Άλλο..." από το υπομενού.  Πατήστε το "Απλό" στον οδηγό, και επιλέξτε "Αρχείο" στη λίστα που βρίσκεται στα αριστερά.  Πατήστε στο "Επόμενο" για να δώσετε το όνομα του αρχείου (βεβαιωθείτε ότι η επέκταση είναι .readme) και το φάκελο στον οποίο πρέπει να περιέχεται το αρχείο.

Οδηγοί δημιουργίας παραδείγματος

Από το μενού "Αρχείο", επιλέξτε "Δημιουργία" και από το υπομενού επιλέξτε "Παράδειγμα...".  Επιλέξτε τους οδηγούς δημιουργίας παραδείγματος. Επιλέξτε "Αρχείο readme". Πατήστε "Επόμενο". Επιλέξτε το φάκελο στον οποίο επιθυμείτε να δημιουργηθεί το αρχείο. Πληκτρολογήστε το όνομα του αρχείου επέκταση .readme. Πατήστε "Ολοκλήρωση".

Ενέργεια επέκτασης προβολής αρχείου readme

Στην προβολή "Πλοήγηση" επιλέξτε ένα αρχείο με επέκταση .readme. Εάν δεν υπάρχει κάποιο, δημιουργήστε ένα αρχείο με αυτή την επέκταση. Στην τοπική γραμμή εργαλείων της προβολής "Πλοήγηση", θα δείτε ένα κουμπί του οποίου η αναδυόμενη βοήθεια αναφέρει "Εκτέλεση επέκτασης προβολής αρχείου readme".  Πατήστε σε αυτό το κουμπί.  Θα εμφανιστεί ένα αναδυόμενο πλαίσιο διαλόγου που αναφέρει "Εκτέλεση ενέργειας προβολής".

Αναδυόμενα μενού

Στην προβολή "Πλοήγηση", επιλέξτε ένα αρχείο με επέκταση .readme.  Εάν δεν υπάρχει κάποιο, δημιουργήστε ένα αρχείο με αυτή την επέκταση.  Επιλέξτε το αρχείο για να εμφανιστεί το αναδυόμενο μενού.  Παρατηρήστε ότι υπάρχει ένα στοιχείο μενού που αναφέρει "Εμφάνιση ενέργειας αρχείου readme" στο αναδυόμενο μενού. Επιλέξτε αυτό το στοιχείο μενού για το άνοιγμα ενός πλαισίου διαλόγου που θα αναφέρει "Εκτέλεση ενέργειας αναδυόμενου μενού".

Σελίδα προτιμήσεων

Από το μενού "Παράθυρο", επιλέξτε "Προτιμήσεις".  Πατήστε στη σελίδα που ονομάζεται "Παράδειγμα αρχείου readme".  Αυτή εμφανίζει ένα παράδειγμα μιας σελίδας προτιμήσεων.

Σελίδα ιδιοτήτων

Στην προβολή "Πλοήγηση", επιλέξτε ένα αρχείο με επέκταση .readme.  Εάν δεν υπάρχει κάποιο, δημιουργήστε ένα αρχείο με αυτή την επέκταση.  Επιλέξτε το αρχείο για να εμφανιστεί το αναδυόμενο μενού, κατόπιν επιλέξτε το στοιχείο μενού "Ιδιότητες".  Πατήστε στη σελίδα που ονομάζεται "Εργαλείο διαχείρισης αρχείων readme" για να δείτε ένα παράδειγμα μιας σελίδας ιδιοτήτων.

Λειτουργία επεξεργασίας αρχείου readme

Η λειτουργία επεξεργασίας αρχείων readme αποτελεί την προεπιλεγμένη λειτουργία επεξεργασίας για αρχεία του είδους *.readme.  Δημιουργήστε ένα αρχείο με επέκταση .readme και ανοίξτε το αρχείο διπλοπατώντας το, ή εμφανίζοντας το αναδυόμενο μενού,  επιλέγοντας "Άνοιγμα με", και κατόπιν επιλέγοντας "Λειτουργία επεξεργασίας αρχείων readme" από το υπομενού.  Παρατηρήστε ότι η λειτουργία επεξεργασίας διαθέτει ένα εικονίδιο με ένα μολύβι.  Αυτό αποτελεί τη λειτουργία επεξεργασίας που το εργαλείο διαχείρισης αρχείων readme χρησιμοποιεί ως προεπιλογή για αρχεία του είδους *.readme.

Ενέργειες λειτουργίας επεξεργασίας αρχείων readme

Αυτό δείχνει ένα παράδειγμα ενεργειών που μπορούν να εφαρμοστούν μόνο σε μια συγκεκριμένη λειτουργία επεξεργασίας.  Όταν μια λειτουργία επεξεργασίας αρχείων readme εστιάζεται, παρατηρήστε τα τέσσερα επιπρόσθετα κουμπιά της γραμμής εργαλείων - Εκτέλεση επέκτασης λειτουργίας επεξεργασίας αρχείων readme, Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 1, Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 2, Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 3.

Εμφανίζεται ένα αναπτυσσόμενο μενού που ονομάζεται "Αρχείο readme" όταν η λειτουργία επεξεργασίας αρχείων readme έχει την εστίαση.  Περιέχει τις ενέργειες που περιγράφηκαν παραπάνω. Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 1, Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 2, Ενέργεια λειτουργίας επεξεργασίας αρχείων readme 3.

Προβολή "Ενότητες αρχείων readme"

Για να δείτε την προβολή "Ενότητες αρχείων readme", από το μενού "Παράθυρο" επιλέξτε "Εμφάνιση προβολής", και μετά επιλέξτε "Άλλο..." από το υπομενού.  Αναπτύξτε το στοιχείο "Αρχείο readme" και κατόπιν επιλέξτε "Ενότητες αρχείων readme".  Με αυτό τον τρόπο θα εμφανιστεί μια λίστα των ενοτήτων στο τρέχον αρχείο *.readme όταν ένα αρχείο .readme επιλέγεται στην προβολή "Πλοήγηση".  Μπορείτε επίσης να δείτε τη δομή ενός αρχείου *.readme στην προβολή "Διάρθρωση".

Ένα αρχείο με επέκταση .readme μπορεί να χωριστεί σε ενότητες όταν κάθε ενότητα ξεκινάει με έναν αριθμό.  Για παράδειγμα, εάν το ακόλουθο κείμενο καταχωρηθεί στη λειτουργία επεξεργασίας αρχείων readme, το εργαλείο διαχείρισης αρχείων readme θα εντόπιζε δυο ενότητες.  Για να δείτε τον τρόπο εντοπισμού των ενοτήτων στο εργαλείο διαχείρισης αρχείων readme, πληκτρολογήστε ένα μέρος κειμένου στη λειτουργία επεξεργασίας αρχείων readme, αποθηκεύστε το αρχείο είτε πατώντας τα πλήκτρα CTRL-S είτε επιλέγοντας  "Αρχείο->Αποθήκευση". Ανοίξτε την προβολή "Ενότητες αρχείων readme" και επιλέξτε το αρχείο .readme στην προβολή "Πλοήγηση".

Κείμενο παραδείγματος

99.1 This is my first section
This is some text in my first section.

99.1.1 This is a sub section
This is some text in my sub-section.

Τράβηγμα και εναπόθεση

Μπορείτε να δείτε τη λειτουργικότητα "Τράβηγμα και εναπόθεση" επιλέγοντας μια ενότητα στην προβολή "Διάρθρωση" και τραβώντας την επιλογή στην κορυφή ενός αρχείου κειμένου. Τα περιεχόμενα της επιλογής θα προσαρτηθούν στο αρχείο.

Συνεισφορά βοήθειας

Το παράδειγμα εργαλείου διαχείρισης αρχείων readme δείχνει επίσης τον τρόπο χρήσης και υλοποίησης συμφραστικής βοήθειας σε όλες τις επεκτάσεις που παρέχει - μια προβολή, διάφορες ενέργειες και μια σελίδα οδηγού.   Για να λάβετε συμφραστική βοήθεια για μια ενέργεια, τοποθετήστε το δείκτη του ποντικιού πάνω από το στοιχείο μενού, αλλά μην το επιλέξετε, και κατόπιν πατήστε το πλήκτρο F1.  Μπορείτε επίσης να λάβετε συμφραστική βοήθεια (F1) στην προβολή "Ενότητες αρχείων readme" και τη σελίδα "Οδηγοί δημιουργίας παραδείγματος (στον οδηγό δημιουργίας).
 

Λεπτομέρειες

Το παράδειγμα "Εργαλείο διαχείρισης αρχείων readme" δηλώνει ένα σημείο επέκτασης και παρέχει ένα αριθμό επεκτάσεων.  Οι επεκτάσεις που παρέχονται είναι αρκετά περιεκτικές για την κατανόηση του τρόπου λειτουργίας του πάγκου εργασίας, καθώς χρησιμοποιεί μερικά από τα περισσότερο ενδιαφέροντα σημεία επέκτασης που δηλώνονται από τον πάγκο εργασίας.  Οι παρεχόμενες επεκτάσεις που περιλαμβάνονται σε αυτό το παράδειγμα αποτελούν προβολές και ενέργειες προβολών, σελίδες προτιμήσεων, σελίδες ιδιοτήτων, οδηγούς, λειτουργίες επεξεργασίας και ενέργειες λειτουργιών επεξεργασίας, αναδυόμενα μενού, σύνολα ενεργειών, συνεισφορές βοήθειας, περιβάλλον βοήθειας και ενέργειες εναπόθεσης.

Αυτό το παράδειγμα παρέχει επίσης ένα σημείο επέκτασης που δηλώνεται στην πρόσθετη λειτουργία. Η κλάση IReadmeFileParser απαιτείται για οποιαδήποτε πρόσθετη λειτουργία που χρησιμοποιεί την επέκταση org.eclipse.ui.examples.readmetool.sectionParser που ορίζει αυτό το παράδειγμα. Η κλάση DefaultSectionParser αποτελεί ένα παράδειγμα υλοποίησης του IReadmeFileParser.

Η κλάση ReadmeEditor υλοποιεί το IEditorPart και ορίζεται ως μια λειτουργία επεξεργασίας σε αρχεία με επέκταση .readme στο plugin.xml που χρησιμοποιεί το σημείο επέκτασης org.eclipse.ui.editors. Η κλάση ReadmeSectionsView υλοποιεί το IViewPart και ορίζεται ως μια προβολή που χρησιμοποιεί το σημείο επέκτασης org.eclipse.ui.views. Αυτό το σημείο επέκτασης ορίζει επίσης μια κατηγορία για την προβολή για χρήση στην επιλογή προβολής.

Ορίζονται δυο είδη ρυθμίσεων προτιμήσεων σε αυτό το παράδειγμα, οι προτιμήσεις του πάγκου εργασίας και οι ιδιότητες του πόρου. Οι προτιμήσεις του πάγκου εργασίας ορίζονται στην κλάση ReadmePreferencePage η οποία υλοποιεί το IWorkbenchPreferencePage ώστε να προστίθεται στο πλαίσιο διαλόγου "Παράθυρο->Προτιμήσεις". Η κλάση ορίζεται στο σημείο επέκτασης org.eclipse.ui.preferencePages στο plugin.xml. Οι δυο σελίδες ιδιοτήτων πόρων είναι η ReadmeFilePropertyPage και η ReadmeFilePropertyPage2, και οι δυο από τις οποίες υλοποιούν το IWorkbenchPropertyPage. Και οι δυο ορίζονται να κληθούν στο είδος IFile από το προσδιοριστικό objectClass στο plugin.xml στο σημείο επέκτασης org.eclipse.ui.propertyPages.

Η κλάση ReadmeCreationWizard υλοποιεί το INewWizard και ορίζεται στο σημείο επέκτασης org.eclipse.ui.newWizards στο plugin.xml. Αυτό το σημείο επέκτασης ορίζει επίσης την κατηγορία στην οποία εμφανίζεται ο οδηγός όταν ο χρήστης επιλέγει "Αρχείο->Δημιουργία->Παράδειγμα...".

Σε αυτό το παράδειγμα προστίθενται αρκετά στελέχη ενεργειών. Το σύνολο ενεργειών δηλώνει ένα μενού με ετικέτα "Λειτουργία επεξεργασίας αρχείων readme" το οποίο θα συμπεριληφθεί στη γραμμή μενού του παραθύρου του πάγκου εργασίας χρησιμοποιώντας το σημείο επέκτασης org.eclipse.ui.actionSets. Ορίζει επίσης μια ενέργεια για τη γραμμή εργαλείων και τη γραμμή μενού του πάγκου εργασίας χρησιμοποιώντας τα προσδιοριστικά toolbarPath και menubarPath. Χρησιμοποιεί την κλάση WindowActionDelegate η οποία υλοποιεί το IWorkbenchWindowActionDelegate για την υλοποίηση της ενέργειας. Η ενέργεια για το αναδυόμενο μενού ορίζεται ως ένα objectContribution από την κλάση PopupMenuActionDelegate στο  σημείο επέκτασης org.eclipse.ui.popupMenus. Το popupMenuActionDelegate υλοποιεί το IObjectActionDelegate και χρησιμοποιεί το IWorkbenchPart που παρέχεται για το άνοιγμα ενός πλαίσιο διαλόγου μηνύματος. Η ενέργεια προβολής ViewActionDelegate ορίζεται στο σημείο επέκτασης org.eclipse.ui.viewActions και υλοποιεί το IViewActionDelegate. Η προβολή στην οποία εμφανίζεται ορίζεται από το προσδιοριστικό targetID το οποίο σε αυτό το παράδειγμα είναι το org.eclipse.ui.views.ResourceNavigator. Η ενέργεια της λειτουργίας επεξεργασίας ορίζεται από την κλάση EditorActionDelegate που υλοποιεί το IEditorActionDelegate και προστίθεται χρησιμοποιώντας το σημείο επέκτασης org.eclipse.ui.editorActions. Η λειτουργία επεξεργασίας στην οποία εφαρμόζεται ορίζεται από το προσδιοριστικό targetID το οποίο σε αυτό το παράδειγμα ορίζεται στο org.eclipse.ui.examples.readmetool.ReadmeEditor.

Η κλάση ReadmeDropActionDelegate υλοποιεί το IDropDelegate. Τα IDropDelegates ενημερώνονται κάθε φορά που υπάρχει μια ενέργεια εναπόθεσης που εκτελείται στον πάγκο εργασίας. Το σημείο επέκτασης για αυτή την ενέργεια είναι το org.eclipse.ui.dropActions.