Laajenna kaikki Sulje kaikki
Dokumentin nimi: HtmlEditTboxDesigner luokkakuvaus
Dokumentin tekijät Juha Lähteenmäki
Dokumentin jakelu: Juha Lähteenmäki
Dokumentin jakelun rajoitukset Ei rajoituksia
Viimeksi muokattu: 16.07.2003
Dokumentin versiotiedot: (esim. Työversio (beta 1.0),Versiosykli nro 1) versio 1.0, versiosykli 2, (valmistumis pvm: 16.7.03)
Dokumentin kattavuus: Kattaa luokan/moduulin rajapinnan kuvauksen
Dokumentointi malli: STEP työversio beta 1, SoftaSpec Versio 1.0 beta 3
Liittyy osana dokumenttiin: HtmlEditCtrl SoftaSpec
Osan pakollisuus: Pakollinen kaikissa järjestelmissä/komponenteissa.
Dokumentin muutoksia: (ekan version valmistumisen jälkeen) (18.6.03, Juha)
  • Päivitetty dokumentti ajan tasalle toteutuksen jälkeen (Pieniä muutoksia ja lisäyksiä)

(16.7.03, Juha)

  • Päivitetty dokumentointimallin nimi, tarkastettu

 

- Rajapintakuvauksissa käytetyt symbolit

Rajapintasymbolien selitykset
Public Interface
Internal Interface
Public Class
Internal Class
Public Property
Protected Property
Internal Property
Private Property
Public Event
Internal Event
Public Const/Enum
Protected Const/Enum
Internal Const/Enum
Private Const/Enum
Public method
Protected method
Internal method
Private method

 

Käyttöliittymäkuvauksen rajapintasymbolit
Button (painonappi)
ImageButton (kuvapainonappi esim. työkalupaletissa)
CheckBox (valintanappi)
Grid (Gridi)
TextBox
RadioButton
ListBox
DropDownList (ComboBox)
Label
TabControl
DropDownMenu

- Yleistä

Nimi: (myös nimiav.) Web.UI.WebControls.HtmlEditTboxDesigner
Kuvaus: (tehtävä)  

Vastaa HtmlEditTbox-kontrollin näkymisestä (renderöitymisestä) suunnittelutilassa (esim. Visual Studio.Net:llä)

 
Versio: 1.0
Kehitetty osana projektia: HtmlEditCtrl versiosykli 2
Näkyvyysalue: Public
 

Emo komponentin ja/tai paketin nimi:

(jos sisältyy kiinteästi johonkin pakettiin joka ei vaihdu eri projektien puitteissa)

 

 Sisältyy komponenttiin HtmlEditTbox

Arvioidut käyttömahdollisuudet eri projekteissa (Yleiskäyttöisyys aste)

  • 3 (3R)= Täysin yleiskäyttöinen ja tod. näk. hyödyllinen

  • 2 (2R)= Yleiskäyttöinen muttei ehkä hyödyllinen (esim. kapeahko projektispesifinen sovellusalue)

  • 1 (1R)= Osittain yleiskäyttöinen eli vaatii muokkausta ennen uudelleen käyttöä (tai vain tietyt metodit)

  • 0 = Vain tämän projektin käyttöön. Muissa projekteissa korkeintaan pohjana tai mallina

Huom. Yleiskäyttöisyyden arvioinnissa on huomioitava myös luokan riippuvuudet muihin luokkiin/moduuleihin. Yleiskäyttöisyys aste on riippuvuuksien perusteella sama kuin riippuvuussuhteista heikoimman luokan/moduulin yleiskäyttöisyys. R numeron perässä tarkoittaa että ko. luokka on yleiskäyttöinen ryhmänä (komponenttina) eli yhdessä tiettyjen luokkien/moduulien kanssa. Tässä tapauksessa on lueteltava muut moduulit/luokat joiden kanssa annettu yleiskäyttöisyys aste täyttyy.

 

 3R HtmlEditTbox-kontrolliin liittyvät muut luokat
yksinään 0

Suorat riippuvuudet:

(luettelona, tarvittaessa luokkakaavio)

 

Web.UI.WebControls.HtmlEditTbox

 

- Käyttöliittymän kontrollit

EditTboxDesigner ei käytä kontrolleja apunaan vaan luo suunnitteluaikaisen käyttöliittymän HtmlEditTbox-kontrollia (ja sen aliluokkia) apuna käyttäen pelkistä html-muotoisista stringeistä.

 

- Rajapinta

Tähän on merkitty näkyviin vain sellaiset kantaluokan metodit, propertyt tai eventit joiden toteutusta tämä periytetty luokka muuttaa. Näissä tapauksissa taulukossa selityksen perässä on suluissa (inherited from kantaluokan nimi). Linkit kantaluokkien/rajapintojen kuvauksiin ennen varsinaista luokkakuvausta.

Näkyviin ei ole merkitty private-tason metodeja, jäsenmuuttujia tai propertyjä. Näkyviin ei myöskään ole merkitty sellaisia protected/internal tason metodeja jotka eivät ole ulkoisen käytön/arkkitehtuurin ymmärtämisen kannalta olennaisia.

Metodien parametrit jätetään kuvauksissa vielä avoimiksi. Suuntaa antavia metodien parametrilistoja voidaan luokkakuvauksiin merkitä mutta tarkat parametrilistat liitetään vasta CodeCommentReporteihin..

Periytyy:

Luokka/rajapinta Kuvaus (erityisesti kantaluokkanäkökulmasta)
System.Web.UI.Desing.ControlDesigner  

.NET:n kontrolli Designerien kantaluokka.

 

 

Rajapinta
Rajapintametodi/property/eventti Kuvaus
GetDesignTimeHtml():string  
Palauttaa HtmlEditTbox:ia vastaavan suunnittelunaikaisen Html:n toiminta seuraavaa:
  1. Luo ilmentymä HtmlEditTbox-kontrollista (HtmlEditTbox vControl = (HtmlEditTbox) Component)
  2. Luo suunnittelun aikaisen html:n pääkehyksen alkutagi (taulukko) ja alusta sitä vastaavat ominaisuudet
  3. Pyydä toolbar:lta suunnittelun aikainen Html (vControl.ToolBar.GetDesignTimeHtml())
  4. Pyydä editorilta suunnittelun aikainen Html (vControl.EditTextBox.GetDesignTimeHtml())
  5. Luo lopputagi taulukolle

Huom. alikontrolleilta pyydetyt suunnittelun aikaiset Html:t tulevat valmiiksi alustettuina siis ominaisuuksien mukaisina.

(inherited from ControlDesigner)

Tämä toiminto voidaan tarvittaessa jakaa sopiviin palasiin joko protected tai private tasolla.

Virhekäsittely: Ei mietitty