Verktyg, gränssnitt och deskriptorer

Dynamix innehåller ett stort antal UI-kontroller (träd, menyer och toolbars m fl) som kan användas för att designa dialoger och verktyg. Ofta är det dock inte nödvändigt att själv bygga ihop verktygen från de minsta UI-beståndsdelarna. Ett bra alternativ är att beskriva egendesignade objekt med deskriptor-attribut och använda någon av Dynamix dialoglayouter för verktyget.

Hantering av objekt - listutseende

Hantering av objekt - trädutseende

Dynamix tillhandahåller som standard två gränssnittsvarianter - listvy och trädvy.

Layouterna innehåller de vanligaste redigeringsfunktionerna:

  • Ny, redigera, ta bort

  • Kopiera, klipp ut, klistra in

  • Behörighetshantering

Om dessa inte är tillräckliga går det att anpassa med egna toolbarknappar, menyer, listkolumner mm.

Hur fungerar det?

I vårt exempel ska vi bygga ett redigeringsverktyg för det egna objektet QA (Question and Answer). Det innehåller egenskaperna Question, Answer och Image.

  1. C#
  1. using System;
  2. using System.Runtime.Serialization;
  3. using Dynamix;
  5. using Dynamix.Descriptors.UI;
  6. using TestSite.UI.Dialogs;
  8. namespace TestSite
  9. {
  10. [Serializable]
  11. [EditObjectDialogDescriptor( typeof( EditQA.UIEditObjectDialogDescriptor ) )]
  12. [Name( "Fråga och svar" )]
  13. public class QA : Dynamix.Object
  14. {
  15. public static readonly TextProperty p_Question = new TextProperty( "Question" );
  16. public static readonly TextProperty p_Answer = new TextProperty( "Answer" );
  17. public static readonly ObjectProperty p_Image = new ObjectProperty( "Image", typeof( Dynamix.Image ), ObjectPropertyFlags.Cascaded );
  19. public QA() {}
  20. protected QA( ObjectID id ) : base( id ) {}
  21. protected QA( SerializationInfo info, StreamingContext context ) : base( info, context ) {}
  23. [Dynamix.Descriptors.UI.Label( "Fråga:" )]
  24. public string Question
  25. {
  26. get { return GetPropertyValue( p_Question ); }
  27. set { SetPropertyValue( p_Question, value ); }
  28. }
  30. [Dynamix.Descriptors.UI.Label( "Svar:" )]
  31. public string Answer
  32. {
  33. get { return GetPropertyValue( p_Answer ); }
  34. set { SetPropertyValue( p_Answer, value ); }
  35. }
  37. [Dynamix.Descriptors.UI.Label( "Bild:" )]
  38. public Dynamix.Image Image
  39. {
  40. get { return (Dynamix.Image)GetPropertyValue( p_Image ); }
  41. set { SetPropertyValue( p_Image, value ); }
  42. }
  44. protected override string IName_Name
  45. {
  46. get { return Question; }
  47. }
  49. public override bool IsUIDeletable
  50. {
  51. get { return true; }
  52. }
  54. public override bool IsUIEditable
  55. {
  56. get { return true; }
  57. }
  59. public static ObjectList All()
  60. {
  61. return Dynamix.Object.All( typeof( QA ) );
  62. }
  64. }
  65. }

Notera attributet EditObjectDialogDescriptor som har satts på klassen. Det pekar ut en deskriptorklass som beskriver den dialog som ska användas för att redigera QA-objekt. I dialogen EditQA är den deifinierad enligt:

  1. C#
  1. [Serializable]
  2. public class UIEditObjectDialogDescriptor :
  3. Dynamix.Descriptors.UI.EditObjectDialogDescriptor
  4. {
  5. public override Url Url
  6. {
  7. get { return new Url( "/Lib/QA/UI/Dialogs/EditQA.aspx" ); }
  8. }
  10. public override Size DialogSize
  11. {
  12. get { return new Size( 791, 543 ); }
  13. }
  15. public override string GetNewTitle()
  16. {
  17. return "Ny fråga och svar";
  18. }
  20. public override string GetEditTitle(Dynamix.Object o)
  21. {
  22. return "Redigera fråga och svar";
  23. }
  25. }

Verktyget

Nu är det dags att definiera själva verktyget som ska lista frågor och svar samt ge redaktören möjlighet att hantera dem (redigera, ta bort och skapa nya). Verktyget definieras på samma sätt som andra Dynamix-verktyg, skillnaden är varifrån DialogInfo hämtas.

  1. C#
  1. using System;
  2. using System.Runtime.Serialization;
  3. using Dynamix;
  4. using Dynamix.UI.Controls;
  6. namespace TestSite.Tools
  7. {
  8. [Serializable]
  9. [Dynamix.Definitions.Tool]
  10. public class QATool : Tool
  11. {
  13. protected QATool( ObjectID id ) : base( id ) {}
  14. protected QATool( SerializationInfo info, StreamingContext context ) : base( info, context ) {}
  15. public QATool() : base() {}
  17. public override string Name
  18. {
  19. get { return "Frågor och svar"; }
  20. }
  22. public override Dynamix.UI.DialogInfo DialogInfo()
  23. {
  24. QAToolDialogDescriptor desc = new QAToolDialogDescriptor();
  25. return Dynamix.UI.Dialogs.GeneralDialog.DialogInfo( desc );
  26. }
  28. public static QATool Instance
  29. {
  30. get { return (QATool)GetInstance( typeof( QATool ) ); }
  31. }
  32. }
  34. [Serializable]
  35. public class QAToolDialogDescriptor :
  36. Dynamix.Descriptors.UI.ListItemsDialogDescriptor
  37. {
  38. public override bool IsAllowedToViewPage
  39. {
  40. get { return QATool.Instance.CurrentUserIsAllowed; }
  41. }
  42. }
  43. }

Dialogen som ska visas är Dynamix.UI.Dialogs.GeneralDialog. Denna dialog har ingen egen layout utan kräver ett objekt av typen DialogDescriptor som i sin tur beskriver hur dialogen ska se ut och fungera.

I det här fallet används den egna klassen QAToolDialogDescriptor som ärver från ListItemsDialogDescriptor. Det enda vi ändrar är hur säkerhetskontrollen ska gå till, i det här fallet ska den inloggade användaren ha tillgång till QATool-verktyget.

När verkyget har installerats och visas i sajten ser det ut enligt:

Ännu så länge är inga funktioner tillgängliga. Anledningen är att vi ingenstans har sagt vilka objekt som ska visas och få redigeras i dialogen. För att definiera detta överlagrar vi fler funktioner i dialog-deskriptorn:

  1. C#
  1. [Serializable]
  2. public class QAToolDialogDescriptor :
  3. Dynamix.Descriptors.UI.ListItemsDialogDescriptor
  4. {
  5. public override bool IsAllowedToViewPage
  6. {
  7. get { return QATool.Instance.CurrentUserIsAllowed; }
  8. }
  10. public override System.Collections.ICollection GetAllowedTypes()
  11. {
  12. return new Type[] { typeof( QA ) };
  13. }
  15. public override ObjectList GetItems()
  16. {
  17. ObjectList items = new ObjectList( QA.All() );
  18. items.Sort( QA.p_Question.AscendingComparer );
  19. return items;
  20. }
  22. }

Resultatet blir:

I Ny-menyn visas de objekttyper som kan dialogen känner till. Listan hämtas från deskriptorns GetAllowedTypes()-metod. För varje objekttyp visas en text som hämtas från deskriptorns GetTypeName()-metod. Basimplementationen är att använda namn från attributet Dynamix.Descriptors.UI.Name om ett sådant finns satt på klassen (se QA-klassens kod högst upp i artikeln).

I listan visas de poster som kommer ur deskriptorns GetItems()-metod. I exemlet returnerar vi alla QA-objekt sorterade efter frågetexten. Som standard visas en ikon- och en namnkolumn, där ikonen hämtas från objektets IDisplayItem-implementation och namnet från objektets IName-implementation. För Dynamix.Object (som QA ärver från) överlagras enklast IName_Name och IDisplayItem_IconUrl. I vårt exempel har vi överlagrat IName_Name till att visa frågetexten. Mer om dessa interface finns bland länkarna i slutet av artikeln

Fler möjligheter

Ta bort och Redigera-funktionerna är bara aktiva om deskriptorn svarar med värdet true på frågorna IsDeletable respektive IsEditable. Standardimplementationen är att returnera objektets värde för IsUIDeletable och IsUIEditable, men genom att överlagra i deskriptorn är det alltså fullt möjligt att införa speciella regler för vissa objekt i gränssnittet istället för att låta objektet själv bestämma.

Det finns också möjligheter att överlagra funktioner för att bl a:

  • Skapa och rita ut fler kolumner eller ändra på befintliga

  • Lägga till egna toolbarknappar och menyer

  • Hantera vad som händer vid klipp ut, kopiera och klistra in

  • Hantera hur objekt ska sparas

Läs mer