Added mor POD to the graphing system and adjusted the palette api to be more robust.

lib/WebGUI/Image/Palette.pm

@@ -4,6 +4,17 @@ use strict;
 use WebGUI::Image::Color;
 
 #-------------------------------------------------------------------
+=head1 addColor ( color )
+
+Adds a color to this palette. The color will be automatically saved or updated
+to the database.
+
+=head2 color
+
+A WebGUI::Image::Color object.
+
+=cut
+
 sub addColor {
 	my $self = shift;
 	my $color = shift;
@@ -20,6 +31,12 @@ sub addColor {
 }
 
 #-------------------------------------------------------------------
+=head1 canDelete
+
+Returns true if this palette can be deleted.
+
+=cut
+
 sub canDelete {
 	my $self = shift;
 
@@ -28,6 +45,12 @@ sub canDelete {
 }
 
 #-------------------------------------------------------------------
+=head1 canEdit
+
+Returns true if this palette can be edited.
+
+=cut
+
 sub canEdit {
 	my $self = shift;
 
@@ -35,6 +58,15 @@ sub canEdit {
 }
 
 #-------------------------------------------------------------------
+=head1 delete
+
+Deletes the palette from the database. This is only possible if the canDelete
+method returns true.
+
+NOTE: For now the colors in the palette are not deleted automatically.
+
+=cut
+
 sub delete {
 	my $self = shift;
 	
@@ -49,6 +81,14 @@ sub delete {
 }
 
 #-------------------------------------------------------------------
+=head1 getColor ( [ index ] )
+
+Returns the color at index in the palette. If index is not passed it will return
+the color at the index specified by the internal palette index counter, ie. the
+current color.
+
+=cut
+
 sub getColor {
 	my $self = shift;
 	my $index = shift || $self->getPaletteIndex;
@@ -57,13 +97,52 @@ sub getColor {
 }
 
 #-------------------------------------------------------------------
-sub getColorsInPalette {
-	my $self = shift;
+=head1 getColorIndex ( color )
 
-	return $self->{_palette};
+Returns the index of color. If the color is not in the palette it will return
+undef.
+
+=head2 color
+
+A WebGUI::Image::Color object.
+
+=cut
+
+sub getColorIndex {
+	my (@palette, $index);
+	my $self = shift;
+	my $color = shift;
+	
+	my @palette = @{$self->getColorsInPalette};
+	
+	for ($index = 0; $index < scalar(@palette); $index++) {
+		return $index if ($self->getColor($index)->getId eq $color->getId);
+	}
+
+	return undef;
 }
 
 #-------------------------------------------------------------------
+=head1 getColorsInPalette
+
+Returns a arrayref containing all color objects in the palette.
+
+=cut
+
+sub getColorsInPalette {
+	my $self = shift;
+
+	# Copy ref so people cannot overwrite 
+	return [ @{$self->{_palette}} ];
+}
+
+#-------------------------------------------------------------------
+=head1 getDefaultPaletteId
+
+Returns the id of the default palette.
+
+=cut
+
 sub getDefaultPaletteId {
 	my $self = shift;
 
@@ -71,6 +150,12 @@ sub getDefaultPaletteId {
 }
 
 #-------------------------------------------------------------------
+=head1 getId
+
+Returns the guid of this palette.
+
+=cut
+
 sub getId {
 	my $self = shift;
 	
@@ -78,6 +163,12 @@ sub getId {
 }
 
 #-------------------------------------------------------------------
+=head1 getName
+
+Returns the name of this palette.
+
+=cut
+
 sub getName {
 	my $self = shift;
 	
@@ -85,6 +176,15 @@ sub getName {
 }
 
 #-------------------------------------------------------------------
+=head1 getNextColor
+
+Returns the next color in the palette relative to the internal palette index
+counter, and increases this counter to that color. If the counter already is at
+the last color in the palette it will cycle around to the first color in the
+palette.
+
+=cut
+
 sub getNextColor {
 	my $self = shift;
 
@@ -96,6 +196,12 @@ sub getNextColor {
 }
 
 #-------------------------------------------------------------------
+=head1 getNumberOfColors
+
+Returns the number of colors in the palette.
+
+=cut
+
 sub getNumberOfColors {
 	my $self = shift;
 
@@ -103,6 +209,13 @@ sub getNumberOfColors {
 }
 
 #-------------------------------------------------------------------
+=head1 getPaletteIndex
+
+Returns the index the internal palette index counter is set to. Ie. it returns
+the current color.
+
+=cut
+
 sub getPaletteIndex {
 	my $self = shift;
 
@@ -110,6 +223,13 @@ sub getPaletteIndex {
 }
 
 #-------------------------------------------------------------------
+=head1 getPaletteList
+
+Returns a hashref containing a list of all available palettes. The keys are the
+palette id's and the value are the names of the palettes.
+
+=cut
+
 sub getPaletteList {
 	my $self = shift;
 	my $session = shift || $self->session;
@@ -118,6 +238,15 @@ sub getPaletteList {
 }
 
 #-------------------------------------------------------------------
+=head1 getPreviousColor
+
+Returns the previous color in the palette relative to the internal palette index
+counter, and decreases this counter to that color. If the counter already is at
+the first color in the palette it will cycle around to the last color in the
+palette.
+
+=cut
+
 sub getPreviousColor {
 	my $self = shift;
 
@@ -129,6 +258,26 @@ sub getPreviousColor {
 }
 
 #-------------------------------------------------------------------
+=head1 new ( session, paletteId, [ name ])
+
+Constructor for this class. 
+
+=head2 session
+
+A WebGUI::Session object.
+
+=head2 paletteId
+
+The guid of the palette you want to instanciate. If you want to create a new
+palette use 'new' for this value.
+
+=head2 name
+
+The name of this palette. If not given it will default to 'untitled'. You can
+also adjust this parameter through the setName method.
+
+=cut
+
 sub new {
 	my ($properties, $colors);
 	my $class = shift;
@@ -166,24 +315,47 @@ sub new {
 }
 
 #-------------------------------------------------------------------
+=head1 removeColor ( index )
+
+Removes color at index.
+
+NOTE: This method does not delete the color from the database. If you want to do
+this you must do it manually.
+
+=head2 index
+
+The index of the color you want to remove. If not given nothing will happen.
+
+=cut
+
 sub removeColor {
 	my $self = shift;
-	my $color = shift;
+	my $paletteIndex = shift;
 
-	my $newColors = shift;
-
-	foreach (@{$self->{_palette}}) {
-		push(@$newColors, $_) unless ($_->getId eq $color->getId);
-	}
-	$self->{_palette} = $newColors;
+	return undef unless (defined $paletteIndex);
+	
+	my $color = $self->getColor($paletteIndex);
+	
+	splice(@{$self->{_palette}}, $paletteIndex, 1);
 	
 	$self->session->db->write('delete from imagePaletteColors where paletteId=? and colorId=?', [
 		$self->getId,
 		$color->getId,
 	]);
+	$self->session->db->write('update imagePaletteColors set paletteOrder=paletteOrder-1 where paletteId=? and paletteOrder > ?', [
+		$self->getId,
+		$paletteIndex,
+	]);
+	
 }
 
 #-------------------------------------------------------------------
+=head1 session
+
+Returns the WebGUI::Session object.
+
+=cut
+
 sub session {
 	my $self = shift;
 
@@ -191,6 +363,54 @@ sub session {
 }
 
 #-------------------------------------------------------------------
+=head1 setColor ( index, color )
+
+Sets palette position index to color. This method will automatically save or
+update the color. Index must be within the current palette. To add additional
+colors use the addColor method.
+
+=head2 index
+
+The index within the palette where you want to put the color.
+
+=head2 color
+
+The WebGUI::Image::Color object.
+
+=cut
+
+sub setColor {
+	my $self = shift;
+	my $index = shift;
+	my $color = shift;
+
+	return undef if ($index >= $self->getNumberOfColors);
+	return undef if ($index < 0);
+	return undef unless (defined $index);
+	return undef unless (defined $color);
+
+	$color->save;
+
+	$self->session->db->write('update imagePaletteColors set colorId=? where paletteId=? and paletteOrder=?', [
+		$color->getId,
+		$self->getId, 
+		$index + 1,
+	]);
+	
+	$self->{_palette}->[$index] = $color;
+}
+
+#-------------------------------------------------------------------
+=head setName ( name )
+
+Set the name of this palette.
+
+=head2 name
+
+A scalar containing the desired name.
+
+=cut
+
 sub setName {
 	my $self = shift;
 	my $name = shift;
@@ -204,16 +424,55 @@ sub setName {
 }
 
 #-------------------------------------------------------------------
+=head1 setPaletteIndex ( index )
+
+Set the internal palette index counter. In other words, it sets the current
+color to the specified index. If index exceeds the maximum index number it will
+be set to the maximum index.
+
+=head2 index
+
+The index you want to set the counter to.
+
+=cut
+
 sub setPaletteIndex {
 	my $self = shift;
 	my $index = shift;
 	
+	return undef unless (defined $index);
+	
+	$index = ($self->getNumberOfColors - 1) if ($index >= $self->getNumberOfColors);
+	$index = 0 if ($index < 0);
+	
 	$self->{_paletteIndex} = $index;
 }
 
 #-------------------------------------------------------------------
+=head1 swapColors ( firstIndex, secondIndex )
+
+Swaps the position of two colors within the palette.
+
+=head2 firstIndex
+
+The index of one of the colors to swap.
+
+=head2 secondIndex
+
+The index of the other color to swap.
+
+=cut
+
 sub swapColors {
-	#### Implementeren!
+	my $self = shift;
+	my $indexA = shift;
+	my $indexB = shift;
+
+	my $colorA = $self->getColor($indexA);
+	my $colorB = $self->getColor($indexB);
+
+	$self->setColor($indexA, $colorB);
+	$self->setColor($indexB, $colorA);
 }
 
 1;