Matrix

java.lang.Object
- cz.gyarab.util.light.Matrix

```
public class Matrix
extends java.lang.Object
```
Univerzální třída pro práci se světelným polem. Pole může pracovat ve 4 režimech:
- createSingle() vytvoří panel s jedním světlem
- createHorizontal(int) vytvoří vodorovnou řadu světel
- createVertical(int) vytvoří svislý sloupec světel
- createMatrix(int, int) vytvoří obdélníkové pole světel
Po vytvoření pole je třeba buď umístit grafickou komponentu do existující grafického prostředí (ve výchozím nastavení se vytváří Swingová komponenta SwingCircleLightPanel, to lze změnit nastavením továrny na komponenty) nebo v jednoduchých případech postačí vytvořit okno aplikace voláním showWindow().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Matrix`	`createHorizontal(int width)` Vytvoří vodorovnou řadu světel.
`static Matrix`	`createMatrix(int width, int height)` Vytvoří světelné pole.
`static Matrix`	`createSingle()` Vytvoří jednoduché světlo.
`static Matrix`	`createVertical(int height)` Vytvoří svislý sloupec světel.
`LightColor`	`getBackground()` Zjistí barvu pozadí celého panelu.
`LightColor`	`getBackground(int col, int row)` Zjistí barvu pozadí konkrétního světla pole.
`LightColor`	`getColor()` Zjistí nastavenou barvu popředí, která se přiděluje světlům, když se rozsvěcují např. pomocí `setOn(int, int)`.
`LightColor`	`getColor(int col, int row)` Zjistí aktuální barvu popředí světla pole.
`int`	`getHeight()` Zjistí výšku (počet řádků) světelného pole.
`InteractiveLightPanel`	`getInteractiveLightPanel()` Zjistí světelný panel, který implementuje uživatelské rozhraní.
`LightPanel`	`getLightPanel()` Zjistí aktuální světelený panel, který implementuje grafické rozhraní.
`int`	`getSize()` Zjistí velikost (počet světel) řady nebo sloupce.
`java.lang.String`	`getTitle()` Zjistí titulek okna.
`int`	`getWidth()` Zjistí šířku (počet sloupců) světelného pole.
`void`	`hideWindow()` Skryje okno se světelným polem, zapamatuje si pozici a velikost pro případ opětovného zobrazení.
`boolean`	`isOff()` Zjistí, zda je jednoduché světlo zhasnuté.
`boolean`	`isOff(int index)` Zjistí, zda je světlo v řadě nebo sloupci zhasnuté.
`boolean`	`isOff(int col, int row)` Zjistí, zda je světlo v poli zhasnuté.
`boolean`	`isOn()` Zjistí, zda je jednoduché světlo rozsvícené.
`boolean`	`isOn(int index)` Zjistí, zda je světlo v řadě nebo sloupci rozsvícené.
`boolean`	`isOn(int col, int row)` Zjistí, zda je světlo v poli rozsvícené.
`static void`	`main(java.lang.String[] args)` Spustí demonstraci použití této třídy.
`void`	`setBackground(int col, int row, LightColor color)` Nastaví barvu pozadí konkrétnímu světlu pole.
`void`	`setBackground(LightColor background)` Nastaví barvu pozadí pro celý panel.
`void`	`setColor(int col, int row, LightColor color)` Nastaví barvu popředí konkrétnímu světlu pole.
`void`	`setColor(LightColor color)` Nastaví barvu popředí všem světlům, které se od tohoto okamžiku rozsívítí např. pomocí `setOn(int, int)`.
`void`	`setLightPanelFactory(LightPanelFactory lightPanelFactory)` Nastaví továrnu na výrobu grafického uživatelského rozhraní světelného pole.
`void`	`setOff()` Zhasne jednoduché světlo.
`void`	`setOff(int index)` Zhasne světlo v řadě nebo sloupci.
`void`	`setOff(int col, int row)` Zhasne světlo v poli.
`void`	`setOn()` Rozsvítí jednoduché světlo.
`void`	`setOn(int index)` Rozsvítí světlo v řadě nebo sloupci.
`void`	`setOn(int col, int row)` Rozsvítí světlo v poli.
`void`	`setOnOff(boolean on)` Rozsvítí nebo zhasne jednoduché světlo.
`void`	`setOnOff(int index, boolean on)` Rozsvítí nebo zhasne světlo v řadě nebo sloupci.
`void`	`setOnOff(int col, int row, boolean on)` Rozsvítí nebo zhasne světlo v poli.
`void`	`setTitle(java.lang.String title)` Nastaví titulek okna.
`void`	`showWindow()` Zobrazí okno se světelným polem ve výchozí velikosti a pozici.
`java.lang.String`	`toString()` Sestaví textovou reprezentaci světelného pole.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - createSingle
```
public static Matrix createSingle()
```
    Vytvoří jednoduché světlo.
    
    Returns:
    
    jednoduché světlo
  - createHorizontal
```
public static Matrix createHorizontal(int width)
```
    Vytvoří vodorovnou řadu světel.
    
    Parameters:
    
    width - počet světel v řadě
    
    Returns:
    
    řadu světel
  - createVertical
```
public static Matrix createVertical(int height)
```
    Vytvoří svislý sloupec světel.
    
    Parameters:
    
    height - počet světel ve sloupci
    
    Returns:
    
    sloupec světel
  - createMatrix
```
public static Matrix createMatrix(int width,
                                  int height)
```
    Vytvoří světelné pole.
    
    Parameters:
    
    width - počet světel vedle sebe
    
    height - počet světel nad sebou
    
    Returns:
    
    světelné pole
  - main
```
public static void main(java.lang.String[] args)
```
    Spustí demonstraci použití této třídy.
    
    Parameters:
    
    args - (ignoruje)
  - setOnOff
```
public void setOnOff(int col,
                     int row,
                     boolean on)
```
    Rozsvítí nebo zhasne světlo v poli.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    on - true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - setOn
```
public void setOn(int col,
                  int row)
```
    Rozsvítí světlo v poli.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
  - setOff
```
public void setOff(int col,
                   int row)
```
    Zhasne světlo v poli.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
  - isOn
```
public boolean isOn(int col,
                    int row)
```
    Zjistí, zda je světlo v poli rozsvícené.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    Returns:
    
    true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - isOff
```
public boolean isOff(int col,
                     int row)
```
    Zjistí, zda je světlo v poli zhasnuté.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    Returns:
    
    false při rozsvícení, true při zhasnutí
    
    Since:
    
    1.1
  - setOnOff
```
public void setOnOff(int index,
                     boolean on)
```
    Rozsvítí nebo zhasne světlo v řadě nebo sloupci.
    
    Parameters:
    
    index - poloha světla v řadě nebo sloupci
    
    on - true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - setOn
```
public void setOn(int index)
```
    Rozsvítí světlo v řadě nebo sloupci.
    
    Parameters:
    
    index - poloha světla v řadě nebo sloupci
  - setOff
```
public void setOff(int index)
```
    Zhasne světlo v řadě nebo sloupci.
    
    Parameters:
    
    index - poloha světla v řadě nebo sloupci
  - isOn
```
public boolean isOn(int index)
```
    Zjistí, zda je světlo v řadě nebo sloupci rozsvícené.
    
    Parameters:
    
    index - poloha světla v řadě nebo sloupci
    
    Returns:
    
    true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - isOff
```
public boolean isOff(int index)
```
    Zjistí, zda je světlo v řadě nebo sloupci zhasnuté.
    
    Parameters:
    
    index - poloha světla v řadě nebo sloupci
    
    Returns:
    
    false při rozsvícení, true při zhasnutí
    
    Since:
    
    1.1
  - setOnOff
```
public void setOnOff(boolean on)
```
    Rozsvítí nebo zhasne jednoduché světlo.
    
    Parameters:
    
    on - true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - setOn
```
public void setOn()
```
    Rozsvítí jednoduché světlo.
  - setOff
```
public void setOff()
```
    Zhasne jednoduché světlo.
  - isOn
```
public boolean isOn()
```
    Zjistí, zda je jednoduché světlo rozsvícené.
    
    Returns:
    
    true při rozsvícení, false při zhasnutí
    
    Since:
    
    1.1
  - isOff
```
public boolean isOff()
```
    Zjistí, zda je jednoduché světlo zhasnuté.
    
    Returns:
    
    false při rozsvícení, true při zhasnutí
    
    Since:
    
    1.1
  - setColor
```
public void setColor(int col,
                     int row,
                     LightColor color)
```
    Nastaví barvu popředí konkrétnímu světlu pole.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    color - nová barva
    
    Since:
    
    1.2
  - setColor
```
public void setColor(LightColor color)
```
    Nastaví barvu popředí všem světlům, které se od tohoto okamžiku rozsívítí např. pomocí setOn(int, int).
    
    Parameters:
    
    color - budoucí barva popředí světel
    
    Since:
    
    1.0
  - getColor
```
public LightColor getColor(int col,
                           int row)
```
    Zjistí aktuální barvu popředí světla pole.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    Returns:
    
    aktuální barvu popředí, nebo null, pokud je světlo zhasnuté
    
    Since:
    
    1.2
  - getColor
```
public LightColor getColor()
```
    Zjistí nastavenou barvu popředí, která se přiděluje světlům, když se rozsvěcují např. pomocí setOn(int, int).
    
    Returns:
    
    nastavovaná barva popředí
    
    Since:
    
    1.0
  - setBackground
```
public void setBackground(int col,
                          int row,
                          LightColor color)
```
    Nastaví barvu pozadí konkrétnímu světlu pole.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    color - nová barva
    
    Since:
    
    1.2
  - setBackground
```
public void setBackground(LightColor background)
```
    Nastaví barvu pozadí pro celý panel.
    
    Parameters:
    
    background - nová barva pozadí
    
    Since:
    
    1.1
  - getBackground
```
public LightColor getBackground(int col,
                                int row)
```
    Zjistí barvu pozadí konkrétního světla pole.
    
    Parameters:
    
    col - sloupec
    
    row - řádek
    
    Returns:
    
    barvu pozadí světla na zadaných souřadnicích
    
    Since:
    
    1.2.16
  - getBackground
```
public LightColor getBackground()
```
    Zjistí barvu pozadí celého panelu.
    
    Returns:
    
    barvu pozadí
    
    Since:
    
    1.1
  - getWidth
```
public int getWidth()
```
    Zjistí šířku (počet sloupců) světelného pole.
    
    Returns:
    
    počet sloupců
  - getHeight
```
public int getHeight()
```
    Zjistí výšku (počet řádků) světelného pole.
    
    Returns:
    
    počet řádků
  - getSize
```
public int getSize()
```
    Zjistí velikost (počet světel) řady nebo sloupce.
    
    Returns:
    
    počet světel
  - showWindow
```
public void showWindow()
```
    Zobrazí okno se světelným polem ve výchozí velikosti a pozici. Pokud již dříve bylo zobrazeno, bude zobrazeno ve stejné velikosti a pozici, jako při skrytí. Pokud bylo okno zobrazeno a neskryto, nic se nestane.
    
    See Also:
    
    hideWindow()
  - hideWindow
```
public void hideWindow()
```
    Skryje okno se světelným polem, zapamatuje si pozici a velikost pro případ opětovného zobrazení. Pokud již okno bylo skryto nebo ještě nebylo zobrazeno, nic se nestane.
    
    See Also:
    
    showWindow()
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Nastaví titulek okna.
    
    Parameters:
    
    title - nový titulek okna
  - getTitle
```
public java.lang.String getTitle()
```
    Zjistí titulek okna.
    
    Returns:
    
    aktuální titulek okna
  - setLightPanelFactory
```
public void setLightPanelFactory(LightPanelFactory lightPanelFactory)
```
    Nastaví továrnu na výrobu grafického uživatelského rozhraní světelného pole. Výchozí továrna vytváří SwingCircleLightPanel.
    
    Parameters:
    
    lightPanelFactory - nová továrna, nesmí být null
    
    Throws:
    
    java.lang.NullPointerException - pokud je parametr null
  - getLightPanel
```
public LightPanel getLightPanel()
```
    Zjistí aktuální světelený panel, který implementuje grafické rozhraní. Pokud zatím panel nebyl použit, bude nejdříve vytvořen tovární metodou.
    
    Returns:
    
    světelný panel
  - getInteractiveLightPanel
```
public InteractiveLightPanel getInteractiveLightPanel()
                                               throws java.lang.ClassCastException
```
    Zjistí světelný panel, který implementuje uživatelské rozhraní. Pokud tento panel implementuje rozhraní InteractiveLightPanel, vrátí jeho instanci, v opačném případě vyvolá výjimku.
    
    Returns:
    
    světelný panel
    
    Throws:
    
    java.lang.ClassCastException - v případě, že panel vyrobený továrnou neimplementuje InteractiveLightPanel
    
    Since:
    
    1.2
  - toString
```
public java.lang.String toString()
```
    Sestaví textovou reprezentaci světelného pole. Ta se skládá z názvu třídy, rozměru pole a seznamu souřadnic rozsvícených světel. Např. pole o rozměrech 20w 30h s rozsvíceným levým horním a pravým dolním světlem má textovou reprezentaci: Matrix[[20,30],[0,0],[19,29]]. Tuto reprezentaci lze využít pro ladící účely, není vhodná pro předávání strukturovaných informací.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    textová reprezentace světelného pole

Class Matrix

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createSingle

createHorizontal

createVertical

createMatrix

main

setOnOff

setOn

setOff

isOn

isOff

setOnOff

setOn

setOff

isOn

isOff

setOnOff

setOn

setOff

isOn

isOff

setColor

setColor

getColor

getColor

setBackground

setBackground

getBackground

getBackground

getWidth

getHeight

getSize

showWindow

hideWindow

setTitle

getTitle

setLightPanelFactory

getLightPanel

getInteractiveLightPanel

toString