ExtWidget: define a base class for ExtTab

author: Maarten Vanraes <alien@mageia.org> 2016-03-15 23:56:12 +0100
committer: Maarten Vanraes <alien@mageia.org> 2016-03-25 19:29:04 +0100
commit: f570b956d33f56e839ac6b1916f762a8a8845f29 (patch)
tree: 4f4d8248088a03e6e437094462ffa2911bd6e4a0 /lib/ManaTools/Shared/GUI/ExtTab.pm
parent: 30df2cbb133392359e4e80d9f0d954ace7217f6d (diff)
download: manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar
manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.gz
manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.bz2
manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.xz
manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.zip
1 files changed, 31 insertions, 355 deletions
diff --git a/lib/ManaTools/Shared/GUI/ExtTab.pm b/lib/ManaTools/Shared/GUI/ExtTab.pm
index 66f242bb..a6b31ae3 100644
--- a/lib/ManaTools/Shared/GUI/ExtTab.pm
+++ b/lib/ManaTools/Shared/GUI/ExtTab.pm
@@ -12,7 +12,7 @@ use ManaTools::Shared::GUI::ExtTab;
 
 my $exttab = ManaTools::Shared::GUI::ExtTab->new(name => "Tab1", eventHandler => $dialog, parentWidget => $widget, callback => { my $self = shift; my $yevent = shift; my $backenditem = $_; ... });
 
-$exttab->addTabItem("Label 1", $backenditem1, sub {
+$exttab->addSelectorItem("Label 1", $backenditem1, sub {
     my ($self, $parent, $backendItem) = @_;
     my $dialog = $self->parentDialog();
     my $factory = $dialog->factory();
@@ -27,10 +27,10 @@ $exttab->addTabItem("Label 1", $backenditem1, sub {
     my $button2 = $self->addWidget($backendItem->label() .'_button2', $factory->createPushButton('Button 2', $vbox), sub {...}, $backendItem);
     ...
 });
-$exttab->addTabItem("Label 2", $backenditem2, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
-$exttab->addTabItem("Label 3", $backenditem3, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
-$exttab->addTabItem("Label 4", $backenditem4, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
-$exttab->finishedTabItems();
+$exttab->addSelectorItem("Label 2", $backenditem2, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
+$exttab->addSelectorItem("Label 3", $backenditem3, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
+$exttab->addSelectorItem("Label 4", $backenditem4, sub { my ($self, $parent, $backendItem) = @_; my $factory = $self->parentDialog()->factory(); my $vbox = $factory->createVBox($parent); ... } );
+$exttab->finishedSelectorItems();
 
 
 =head1 DESCRIPTION
@@ -78,16 +78,18 @@ use Moose;
 use diagnostics;
 use utf8;
 
-has 'basename' => (
-    is => 'ro',
-    isa => 'Str',
+extends 'ManaTools::Shared::GUI::ExtWidget';
+
+has '+basename' => (
     default => 'ExtTab',
 );
 
-with 'ManaTools::Shared::GUI::EventRole';
+has '+eventType' => (
+    required => 0,
+    default => $yui::YEvent::WidgetEvent,
+);
 
 use yui;
-use ManaTools::Shared::GUI::ReplacePoint;
 
 #=============================================================
 
@@ -104,324 +106,65 @@ use ManaTools::Shared::GUI::ReplacePoint;
 
 =head3 DESCRIPTION
 
-    new is inherited from Moose, to create a ExtTab object
+    new is inherited from ExtWidget, to create a ExtTab object
 
 =cut
 
 #=============================================================
 
-has '+eventType' => (
-    required => 0,
-    default => $yui::YEvent::WidgetEvent,
-);
-
-has 'parentWidget' => (
-    is => 'ro',
-    isa => 'yui::YWidget',
-    required => 1,
-);
-
-has 'callback' => (
-    is => 'ro',
-    isa => 'Maybe[CodeRef]',
-    lazy => 1,
-    default => sub {
-        return undef;
-    }
-);
-
-has 'items' => (
-    is => 'ro',
-    isa => 'ArrayRef[ManaTools::Shared::GUI::ExtTab::Item]',
-    lazy => 1,
-    init_arg => undef,
-    default => sub {
-        return [];
-    }
-);
-
-has 'replacepoint' => (
-    is => 'rw',
-    isa => 'Maybe[ManaTools::Shared::GUI::ReplacePoint]',
-    init_arg => undef,
-    handles => ['addEvent', 'delEvent', 'getEvent', 'addWidget', 'delWidget', 'widget', 'addItem', 'delItem', 'item'],
-    default => sub {
-        return undef;
-    }
-);
-
-has 'tab' => (
-    is => 'ro',
-    isa => 'yui::YDumbTab',
-    init_arg => undef,
-    lazy => 1,
-    builder => 'buildTab',
-);
-
-has 'lastItem' => (
-    is => 'rw',
-    isa => 'Maybe[ManaTools::Shared::GUI::ExtTab::Item]',
-    init_arg => undef,
-    default => sub {
-        return undef;
-    }
-);
-
-has 'itemcollection' => (
-    is => 'rw',
-    isa => 'yui::YItemCollection',
-    init_arg => undef,
-    default => sub {
-        return new yui::YItemCollection();
-    }
-);
-
-#=============================================================
-
-=head2 buildTab
-
-=head3 INPUT
-
-    $self: this object
-
-=head3 DESCRIPTION
-
-    builds the YDumbTab widget
-
-=cut
-
-#=============================================================
-sub buildTab {
-    my $self = shift;
-    my $dialog = $self->parentDialog();
-    my $optFactory = $dialog->optFactory();
-    my $parentWidget = $self->parentWidget();
-
-    # create the tab
-    my $tab = $optFactory->createDumbTab($parentWidget);
-
-    # create a replacepoint on the tab
-    $self->{replacepoint} = ManaTools::Shared::GUI::ReplacePoint->new(parentWidget => $tab);
-
-    # parentEventHandler must be set directly, because we don't add the
-    # eventHandler to a parentEventHandler, instead the events are processed
-    # through the Tab's EventRole processEvent function
-    $self->{replacepoint}->parentEventHandler($self->{eventHandler});
-
-    # don't add any children right away
-    $self->{replacepoint}->finished();
-
-    return $tab;
-}
-
-#=============================================================
-
-=head2 processEvent
+=head2 _selectorItem
 
 =head3 INPUT
 
     $self: this object
     $yevent: yui::YEvent
 
-=head3 DESCRIPTION
-
-    handles the YDumbTab events and executes callback if necessary
-
-=cut
-
-#=============================================================
-sub processEvent {
-    my $self = shift;
-    my $yevent = shift;
-    my $replacepoint = $self->replacepoint();
-    my $items = $self->items();
-
-    # call subevents
-    my $processed = $replacepoint->processEvents($yevent);
-    return $processed if $processed >= 0;
-
-    # only MenuEvents here...
-    return -1 if ($yevent->eventType() != $yui::YEvent::MenuEvent);
-
-    # only items from *this* tab
-    my $yitem = $yevent->item();
-    my $item = $self->findTabItem($yitem);
-    return -1 if !defined($item);
-
-    # build the children
-    $self->buildTabItem($item);
-
-    # execute callback if needed
-    my $callback = $self->callback();
-    my $result = -1;
-    $result = $callback->($self, $yevent, $item->backend()) if defined($callback);
-
-    # mark last item as this one
-    $self->lastItem($item);
-
-    # return result of callback
-    return $result;
-}
-
-#=============================================================
-
-=head2 addTabItem
-
-=head3 INPUT
-
-    $self: this object
-    $label: a label for the YItem
-    $backendItem: a backendItem needed to identify and/or handle the event
-    $buildWidget: a CodeRef to rebuild the widget when required
-
 =head3 OUTPUT
 
-    the created ManaTools::Shared::GUI::ExtTab::Item
+    YItem: the selected item
 
 =head3 DESCRIPTION
 
-    Creates an item and adds it to the ExtTab. Internally, it creates a
-    yui::YItem and adds it to the YItemCollection. If it's the first item,
-    mark it as the lastitem.
+    returns the items that is selected when an event fires
 
 =cut
 
 #=============================================================
-sub addTabItem {
+sub _selectorItem {
     my $self = shift;
-    my $label = shift;
-    my $backendItem = shift;
-    my $buildWidget = shift;
-    my $items = $self->items();
-    my $item = ManaTools::Shared::GUI::ExtTab::Item->new(backend => $backendItem, builder => $buildWidget);
-    push @{$items}, $item;
-    $item->setLabel($label);
-    $item->addToCollection($self->itemcollection());
-    if (scalar(@{$items}) == 1) {
-        $self->lastItem($item);
-    }
-    return $item;
-}
-
-#=============================================================
-
-=head2 findTabItem
-
-=head3 INPUT
-
-    $self: this object
-    $yitem: the YItem to be found
-
-=head3 DESCRIPTION
-
-    returns a ManaTools::Shared::GUI::ExtTab::Item that has the YItem
-
-=cut
-
-#=============================================================
-sub findTabItem {
-    my $self = shift;
-    my $yitem = shift;
-    # loop all the items
-    for my $i (@{$self->items()}) {
-        return $i if ($i->equals($yitem));
-    }
-    return undef;
-}
-
-#=============================================================
-
-=head2 buildTabItem
-
-=head3 INPUT
-
-    $self: this object
-    $item: the item to be built (widgets from this tab will be recreated in the tab)
-
-=head3 DESCRIPTION
-
-    builds an item on the internal replace point
-
-=cut
-
-#=============================================================
-sub buildTabItem {
-    my $self = shift;
-    my $item = shift;
-    my $replacepoint = $self->replacepoint();
-    my $container = $replacepoint->container();
-
-    # clear out any previous children/events
-    $replacepoint->clear();
-
-    # build item's widgetbuilder
-    my $builder = $item->builder();
-    $builder->($self, $container, $item->backend()) if (defined $builder);
-
-    # finished with replacepoint children
-    $replacepoint->finished();
+    my $yevent = shift;
+    return $yevent->item();
 }
 
 #=============================================================
 
-=head2 clearTabItems
+=head2 _buildSelectorWidget
 
 =head3 INPUT
 
     $self: this object
 
-=head3 DESCRIPTION
-
-    clears the tab to prepare for re-adding new items, call finishedTabItems() afterwards
-
-=cut
-
-#=============================================================
-sub clearTabItems {
-    my $self = shift;
-    my $items = $self->items();
-
-    # remove all events before deleting all items
-    $self->clearEvents();
-
-    for (my $i = 0; $i < scalar(@{$items}); $i = $i + 1) {
-        delete $items->[$i];
-    }
-}
-
-#=============================================================
-
-=head2 finishedTabItems
+=head3 OUTPUT
 
-=head3 INPUT
-
-    $self: this object
+    ($selector, $parent): $selector is the YSelectionWidget; $parent is the replacepoint's parent
 
 =head3 DESCRIPTION
 
-    finalizes the items on the ExtTab
+    builds the YDumbTab widget
 
 =cut
 
 #=============================================================
-sub finishedTabItems {
+override('_buildSelectorWidget', sub {
     my $self = shift;
+    my $parentWidget = shift;
+    my $dialog = $self->parentDialog();
+    my $optFactory = $dialog->optFactory();
 
-    # remove all Items before adding
-    $self->tab->deleteAllItems();
-
-    # add items from collection
-    $self->tab->addItems($self->itemcollection);
-
-    # set last item to know the active item
-    my $item = $self->lastItem();
-
-    # show the current one if there is one
-    $self->buildTabItem($item) if defined($item);
-
-    # create a new itemcollection for adding new items
-    $self->itemcollection(new yui::YItemCollection());
-}
+    # create the tab
+    my $tab = $optFactory->createDumbTab($parentWidget);
+    return ($tab, $tab);
+});
 
 #=============================================================
 
@@ -430,70 +173,3 @@ __PACKAGE__->meta->make_immutable;
 
 
 1;
-
-#=============================================================
-
-package ManaTools::Shared::GUI::ExtTab::Item;
-
-use Moose;
-use diagnostics;
-use utf8;
-
-use yui;
-
-has 'builder' => (
-    is => 'ro',
-    isa => 'Maybe[CodeRef]',
-    lazy => 1,
-    default => sub {
-        return undef;
-    }
-);
-
-has 'item' => (
-    is => 'ro',
-    isa => 'yui::YItem',
-    init_arg => undef,
-    default => sub {
-        return new yui::YItem('', 0);
-    }
-);
-
-has 'backend' => (
-    is => 'rw',
-    isa => 'Maybe[Ref]',
-    lazy => 1,
-    default => sub {
-        return undef;
-    }
-);
-
-#=============================================================
-
-sub setLabel {
-    my $self = shift;
-    my $label = shift;
-    my $yitem = $self->item();
-    $yitem->setLabel($label);
-}
-
-sub equals {
-    my $self = shift;
-    my $item = shift;
-    return ($self->item() == $item);
-}
-
-sub addToCollection {
-    my $self = shift;
-    my $collection = shift;
-    my $yitem = $self->item();
-    $yitem->DISOWN();
-    $collection->push($yitem);
-}
-
-#=============================================================
-
-no Moose;
-__PACKAGE__->meta->make_immutable;
-
-1;
author	Maarten Vanraes <alien@mageia.org>	2016-03-15 23:56:12 +0100
committer	Maarten Vanraes <alien@mageia.org>	2016-03-25 19:29:04 +0100
commit	f570b956d33f56e839ac6b1916f762a8a8845f29 (patch)
tree	4f4d8248088a03e6e437094462ffa2911bd6e4a0 /lib/ManaTools/Shared/GUI/ExtTab.pm
parent	30df2cbb133392359e4e80d9f0d954ace7217f6d (diff)
download	manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.gz manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.bz2 manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.tar.xz manatools-f570b956d33f56e839ac6b1916f762a8a8845f29.zip