Moduuli/luokkakuvaus

Laajenna kaikki

Dokumentin nimi:	HtmlEditTboxTextBox 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 beta1, SoftaSpecVersio 1.0 beta 3
Liittyy osana dokumenttiin:	HtmlEditCtrl SoftaSpec
Osan pakollisuus:	Pakollinen kaikissa järjestelmissä/komponenteissa.
Dokumentin muutoksia: (ekan version valmistumisen jälkeen)	(15.3.03, Juha) Lisätty nimiavaruus luokan nimen alkuun Muutettu rakentajan parametreja (18.6.03, Juha) Päivitetty dokumentti ajan tasalle toteutuksen jälkeen (Pieniä muutoksia ja lisäyksiä) (16.7.03) 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.HtmlEditTboxTextBox
Kuvaus: (tehtävä)	Vastaa HtmlEditTbox:n EditTextBox:n lisäämisestä, alustamisesta, ominaisuuksien tallettamisesta ViewStateen (välitetään viite HtmlEditTbox:n ViewStateen) ja EditTextBox:n liittyvistä scripteistä --> vastaa suurimmasta osasta tärkeimpiä toiminnallisia skriptejä.
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)	Riippuu seuraavista toteutuksen aikana lisätyistä luokista: CtrlPartMngr (apuluokka ominaisuuksien toteuttamiseen) (CtrlPartMngr.cs), ICtrlPart (yhteinen rajapintaluokka sekä EditTboxToolbar:lle että EditTboxTexbox:lle) (periytyy) (ICtrlPart.cs)

- Käyttöliittymän kontrollit

EditTbox:n ulkoasu on normaalisti suunnilleen seuraava:

Jäsenkontrollit
Kontrolli	Kuvaus
myTBoxCtrl	Html:n Div tai span kontrolli--> Sisältää Hml-muotoisen tekstin. onblur eventin yhteydessä sisällön tallennus sivulla olevaan piilokenttään

- Rajapinta

Tähän on merkitty näkyviin vain sellaiset kantaluokan metodit, propertyt tai eventit joiden totetusta 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.

Kaikkia propertyjä koskevat tiedot: Virhekäsittely = Jos viewstatea ei alustettu palauttaa oletuksen

Kaikkia skriptien kysely metodeja ts Get...Scripts(...) koskevat seuraavat säännöt. Skriptit palautetaan ilman skriptitageja (ne on siis muualla lisättävä ennen kuin skripti lisätään sivulle). Tämän ansiosta samaan skriptiblokkiin voidaan lisätä muitakin osia. Metodi palauttaa tyhjän stringin mikäli ko. tyypin skriptiä ei tarvita. Jos metodi on muotoa: GetCommon...Script(...) on kyseessä ns. yhteiskäyttöinen skripti ts. tätä skriptiä ei tarvitse lisätä jokaista kontrollia kohden erikseen vaan riittää kun sivulla on yksi kappale. Vastaavasti jokaista kontrollia varten erikseen lisättävät skriptit ovat muotoa GetCtrlSpecific...Script(...).

Periytyy:

Luokka/rajapinta	Kuvaus (erityisesti kantaluokkanäkökulmasta)
System.ComponentModel.Component	.NET:n komponenttien kantaluokka. EditTbox:n täytyy olla komponentti jotta sen sisältämät propertyt näkyvät oikein suunnittelutilassa (Visual Studio.NET)

Rajapinta
Rajapintametodi/property/eventti	Kuvaus
Publics
BackColor	Tekstiosan (EditTextBox) taustaväri Oletus: System.Drawing.SystemColors.Window
BorderColor	Tekstiosan (EditTextBox) reunuksen väri Oletus: System.Drawing.SystemColors.ControlDark
CssClass	Tekstiosan (EditTextBox) css-luokka Id Oletus: ""
HtmlText	Tekstiosan (EditTextBox) sisältämä Html-muotoinen teksti Oletus: ""
ToolTip	Tekstiosan (EditTextBox) ToolTip Oletus: ""
Internals
New(mainTblCell:TableCell, fatherCtrl:WebControl, viewState:StateBag)	Internal rakentaja ottaa parametrinaan sen pääkehyksen (myMainTable) solun johon toolbar halutaan lisätä, isäkontrollinviitteen johon osa lisätään, ViewState StateBag:n (isäkontrollin) yleiset tyyliasetukset . Kutsuu Create() metodia muttei vielä alusta kontrolleja. Ts. ei kutsu Initialize() metodia. Virhekäsittely: Ei mietitty
Create()	Luo lapsikontrollit (EditTexBox:n) (ei vielä alusta niiden tyyliä/muita arvoja) ja lisää ne rakentajan parametrina saadun solun kontrollikokoelmaan. Virhekäsittely: Ei mietitty
Initialize(father:HtmlEditTbox )	Alustaa lapsikontrollit EditTextBox:n renderöintikuntoon. (Esim. alustaa tyylit ja mitat) Parametrinaan ottaa rakentajaa spesifisemmän viitteen isäkontrolliin Virhekäsittely: Ei mietitty
GetCommonStartUpScript():string	Palauttaa EditTextBox:n liittyvän yhteiskäyttöisen, sivun latauksen yhteydessä ajettavan skriptin Virhekäsittely: Ei mietitty
GetCommonScript():string	Palauttaa yhteiskäyttöisen, jonkin eventin yhteydessä ajettavan EditTextBox:n liittyvän skriptin Virhekäsittely: Ei mietitty
GetCtrlSpecificStartUpScript():string	Palauttaa EditTextBox:n liittyvän kontrollikohtaisen sivun latauksen yhteydessä ajettavan skriptin Virhekäsittely: Ei mietitty
GetCtrlSpecificScript():string	Palauttaa kontrollikohtaisen jonkin eventin yhteydessä ajettavan EditTextBox:n liittyvän skriptin Virhekäsittely: Ei mietitty
GetDesignTimeHtml():string	Palauttaa suunnittelun aikana näytettävän EditTextBox:n html:n Virhekäsittely: Ei mietitty