Ready for 7.10.29 development.

lib/WebGUI/Form/Codearea.pm

@@ -0,0 +1,136 @@
+package WebGUI::Form::Codearea;
+
+=head1 LEGAL
+
+ -------------------------------------------------------------------
+  WebGUI is Copyright 2001-2009 Plain Black Corporation.
+ -------------------------------------------------------------------
+  Please read the legal notices (docs/legal.txt) and the license
+  (docs/license.txt) that came with this distribution before using
+  this software.
+ -------------------------------------------------------------------
+  http://www.plainblack.com                     info@plainblack.com
+ -------------------------------------------------------------------
+
+=cut
+
+use strict;
+use base 'WebGUI::Form::Textarea';
+use WebGUI::International;
+
+=head1 NAME
+
+Package WebGUI::Form::Codearea
+
+=head1 DESCRIPTION
+
+Creates a code area form field, which is just like a text area except stretches to fit it's space and allows tabs in it's content.
+
+=head1 SEE ALSO
+
+This is a subclass of WebGUI::Form::Textarea.
+
+=head1 METHODS 
+
+The following methods are specifically available from this class. Check the superclass for additional methods.
+
+=cut
+
+
+#-------------------------------------------------------------------
+
+=head2 definition ( [ additionalTerms ] )
+
+See the super class for additional details.
+
+=head3 additionalTerms
+
+=head4 width
+
+The width of this control in pixels. Defaults to 550 pixels.
+
+=head4 height
+
+The height of this control in pixels.  Defaults to 450 pixels.
+
+=head4 style
+
+Style attributes besides width and height which should be specified using the above parameters. Be sure to escape quotes if you use any.
+
+The following additional parameters have been added via this sub class.
+
+=head4 syntax
+
+The type of syntax highlighting to use by default. The types available are located at
+$WEBGUI_ROOT/www/extras/editarea/edit_area/reg_syntax
+
+=cut
+
+sub definition {
+	my $class = shift;
+	my $session = shift;
+	my $definition = shift || [];
+	push(@{$definition}, {
+		height=>{
+			defaultValue=> 450 
+			},
+		width=>{
+			defaultValue=> 550 
+			},
+		style=>{
+			defaultValue => undef,
+			},
+        syntax => {
+            defaultValue    => "html",
+        },
+    });
+    return $class->SUPER::definition($session, $definition);
+}
+
+#-------------------------------------------------------------------
+
+=head2 getName ( session )
+
+Returns the human readable name of this control.
+
+=cut
+
+sub getName {
+    my ($self, $session) = @_;
+    return WebGUI::International->new($session, 'WebGUI')->get('codearea');
+}
+
+#-------------------------------------------------------------------
+
+=head2 headTags
+
+Includes script files for the code area
+
+=cut
+
+sub headTags {
+    my $self    = shift;
+    my $session = $self->session;
+    $self->SUPER::headTags(@_);
+    $session->style->setScript(
+        $session->url->extras('yui-webgui/build/codeArea/codeArea-min.js')
+    );
+}
+
+#-------------------------------------------------------------------
+
+=head2 toHtml
+
+Add some javascript to fix hitting the tab key.
+
+=cut
+
+sub toHtml {
+    my $self = shift;
+    $self->headTags;
+    my $id = $self->get('id');
+    return $self->SUPER::toHtml(@_)
+        . qq{<script>new YAHOO.WebGUI.CodeArea('$id').render()</script>};
+}
+
+1;