Utökning för lathundsobjekt
ID:
org.eclipse.ui.cheatsheets.cheatSheetItemExtension
Sedan:
3.0
Beskrivning:
Den här utökningspunkten ska användas när en extra knapp behöver läggas till i ett steg i lathunden.
Du kan infoga ett nytt attribut i märkordet "item" i lathundens innehållsfil och när värdet läses i lathundens ramverk sker en kontroll för att ta reda på om det finns en klass registrerad via den här utökningspunkten som hanterar det här attributet. Det attributnamn som återfinns i
lathundens innehållsfil matchas mot alla värden som återfinns i attributet "itemAttribute" för alla registrerade implementeringar av cheatsheetItemExtension. Om en träff påträffas läses den klass in som har angetts för att hantera objektattributet av lathundens ramverk och anropas för att hantera det attribut som har angetts i lathundens innehållsfil. När värdet för objektets attribut har tolkats förblir klassen tillgänglig för lathundens ramverk. När objektet renderas för lathundsvyn anropas klassen på nytt för att hantera tillägget av komponenter till en komposit. Objekten som läggs till i kompositen visas i lathundssteget (för närvarande bredvid hjälpikonen). Den visas endast för det steg som beskrivs i det "item"-märkord där attributet förekom i lathundens innehållsfil. Den föreslagna användningen av den här utökningspunkten är för att lägga till en liten (16x16) knapp med en bild för öppning av en dialogruta när den trycks ned.
Konfigurationsmärkordsuppsättning:
<!ELEMENT extension (itemExtension)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - ett fullständigt ID för målutökningspunkten
- id - ett valfritt ID för utökningsförekomsten
- name - ett valfritt namn på utökningsförekomsten
<!ELEMENT itemExtension EMPTY>
<!ATTLIST itemExtension
itemAttribute CDATA #REQUIRED
class CDATA #REQUIRED>
Använd den här objektutökningen när du vill lägga till element i lathundssteg. Du kan använda den här utökningspunkten när du vill lägga till ikoner och knappar (för närvarande bredvid hjälpikonen) för ett steg i lathunden.
Du anger namnet på ett attribut som du vill infoga i lathundens objektmärkord. Du anger också en klass där tolkningen av attributet värde från lathundens innehållsfil hanteras när lathunden läses in. Attributets värde måste vara en sträng. Den angivna klassen måste vara en underklass till org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
. När lathundens innehållsfil tolkas och läses in anropas den klass som anges i utökningspunkten på nytt via gränssnittet så att bilder eller knappar läggs till i stegen i lathunden (för närvarande bredvid hjälpknappen).
- itemAttribute - Det här attributets värde måste vara strängvärde för ett attributnamn som infogas i ett objektmärkord i lathundens innehållsfil. Om attributets sträng stämmer med ett attribut som tolkas från objektmärkordet i lathundens innehållsfil, läses den angivna klassen in och anropas för att tolka det fullständiga värdet för attributet med hjälp av specifikationen w3 DOM. Den anropas senare för att lägga till kontroller i en komposit, och de tillagda komponenterna (i allmänhet bilder eller knappar) visas i lathundens steg för det angivna objektet (för närvarande bredvid hjälpikonen för det steget).
- class - Det fullständiga klassnamnet för den klass som är en underklass till
org.eclipse.ui.cheatsheets.AbstractItemExtensionElement
för att hantera okända attribut i lathundens innehållsfil och utöka stegen i lathunden. Klassen måste vara publik och ha en publik konstruktionsfunktion med 1-argument som godtar attributets namn
(en String
).
Exempel:
Följande är en exempelimplementation av den här utökningspunkten:
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"
>
<itemExtension
itemAttribute=
"xyzButton"
class=
"com.example.HandleParsingAndAddButton"
>
</itemExtension>
</extension>
Och här är objektattributet för utökningen:
<item title=
"XYZ-rubrik"
xyzButton=
"/icon/button.gif"
/>
Lägg märke till att värdet för attributet i objektmärkordet kan vara VAD SOM HELST. Det kan var vad som helst
eftersom den klass som tolkar attributet är klassen HandleParsingAndAddButton som i det här exemplet tolkar
en sträng /icon/button.gif från attributet. Senare används den informationen för att läsa in gif-bilden och använda den som ikon för en ny knapp.
API-information:
Javadoc-informationen för org.eclipse.ui.cheatsheets.AbstractItemExtensionElement innehåller mer API-information.
Medföljande implementering:
Det tillhandahålls ingen implementering för närvarande.
Copyright (c) 2004, 2006 IBM Corporation and others.
All Rights Reserved. Detta program och medföljande material tillhandahålls under villkoren för Eclipse Public License v1.0 som medföljer denna distribution och finns tillgänglig på
http://www.eclipse.org/legal/epl-v10.html