Add text legend definition

Benjamin Renard
1 parent c958695a
Showing 3 changed files with 116 additions and 1 deletions Show diff stats
src/InputOutput/IHMImpl/Params/PlotImpl/IHMInputOutputParamsPlotClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotLegendsNodeClass.php
src/Request/ParamsRequestImpl/Nodes/Requests/RequestOutputPlotTextLegendNodeClass.php
@@ -357,10 +357,14 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 				throw new Exception('Plot type not implemented.');
 		}
-		//Params Legends
+		//Params Legend
 		if (isset($panelData->{'panel-series-legend'}) && $panelData->{'panel-series-legend'}->{'legend-series-activated'})
 			$this->unmarshallParamsLegend($panelData->{'panel-series-legend'}, $plotNode->getLegends()->getParamsLegend());
+		//Text Legends
+		foreach ($panelData->{'text-legends'} as $textLegendData)
+			$this->unmarshallTextLegend($textLegendData, $plotNode->getLegends());
+		
 		return $plotNode;
 	}
@@ -746,6 +750,38 @@ class IHMInputOutputParamsPlotClass extends IHMInputOutputParamsAbstractClass
 			$this->unmarshallFont($paramsLegendData, 'legend-series-font', $paramsLegendNode->getFont());
 	}
+	protected function unmarshallTextLegend($textLegendData, $legendsNode)
+	{
+		$legendNode = $legendsNode->addTextLegend();
+		
+		//Legend text
+		$legendNode->setText($textLegendData->{'legend-text-value'});
+		
+		//Legend position
+		switch ($textLegendData->{'legend-text-position'})
+		{
+			case 'top' :
+				$legendNode->setPosition(RequestOutputPlotTextLegendPositionEnum::TOP);
+				break;
+			case 'bottom' :
+				$legendNode->setPosition(RequestOutputPlotTextLegendPositionEnum::BOTTOM);
+				break;
+			case 'left' :
+				$legendNode->setPosition(RequestOutputPlotTextLegendPositionEnum::LEFT);
+				break;
+			case 'right' :
+			default :
+				$legendNode->setPosition(RequestOutputPlotTextLegendPositionEnum::RIGHT);
+		}
+		
+		//Legend text color
+		$legendNode->setColor($this->hexColor2KernelColor($textLegendData->{'legend-text-color'}));
+	
+		//Font
+		if ($textLegendData->{'legend-text-font-activated'})
+			$this->unmarshallFont($textLegendData, 'legend-text-font', $legendNode->getFont());
+	}
+	
 	protected function unmarshallTitle($inputData, $keyPrefix, $titleNode)
 	{
 		if ($inputData->{$keyPrefix.'-text'} != '')
@@ -26,6 +26,13 @@ class RequestOutputPlotLegendsNodeClass extends NodeClass
 		return $node;
 	}
+	
+	public function addTextLegend()
+	{
+		$node = new RequestOutputPlotTextLegendNodeClass();
+		$this->addChild($node);
+		return $node;
+	}
 }
 ?>
 \ No newline at end of file
@@ -0,0 +1,72 @@
+<?php
+
+define ("REQUESTOUTPUTPLOTTEXTLEGEND_NAME", "textLegend");
+define ("REQUESTOUTPUTPLOTTEXTLEGEND_TEXT", "text");
+define ("REQUESTOUTPUTPLOTTEXTLEGEND_POSITION", "position");
+define ("REQUESTOUTPUTPLOTTEXTLEGEND_COLOR", "color");
+
+abstract class RequestOutputPlotTextLegendPositionEnum
+{
+	const LEFT   = "left";
+	const RIGHT  = "right";
+	const BOTTOM = "bottom";
+	const TOP    = "top";
+}
+
+/**
+ * @class RequestOutputPlotTextLegendNodeClass
+ * @brief Definition of a "text legend" element for a plot
+ * @details
+ */
+class RequestOutputPlotTextLegendNodeClass extends NodeClass
+{
+	public function __construct()
+	{
+		parent::__construct(REQUESTOUTPUTPLOTTEXTLEGEND_NAME);
+	}
+	
+	public function setText($text)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_TEXT, $text);
+	}
+	
+	public function getText()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_TEXT);
+	}
+	
+	public function setPosition($position)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_POSITION, $position);
+	}
+	
+	public function getPosition()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_POSITION);
+	}
+	
+	public function setColor($color)
+	{
+		$this->setAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_COLOR, $color);
+	}
+	
+	public function getColor()
+	{
+		return $this->getAttribute(REQUESTOUTPUTPLOTTEXTLEGEND_COLOR);
+	}
+	
+	public function getFont()
+	{
+		$node = $this->getFirstChildByName(REQUESTOUTPUTPLOTPARAMSLEGEND_FONT);
+	
+		if (!isset($node))
+		{
+			$node = new RequestOutputPlotFontNodeClass();
+			$this->addChild($node);
+		}
+	
+		return $node;
+	}
+}
+
+?>
 \ No newline at end of file