fi.paatti.research.paattiapplication.views.eventview
Class EventTool

java.lang.Object
  extended by com.vaadin.ui.AbstractComponent
      extended by com.vaadin.ui.AbstractComponentContainer
          extended by com.vaadin.ui.CustomComponent
              extended by fi.paatti.research.paattiapplication.views.ApplicationViewTab
                  extended by fi.paatti.research.paattiapplication.views.eventview.EventTool
All Implemented Interfaces:
com.vaadin.event.MethodEventSource, com.vaadin.terminal.Paintable, com.vaadin.terminal.Sizeable, com.vaadin.terminal.VariableOwner, com.vaadin.ui.Button.ClickListener, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, Serializable, EventListener

public class EventTool
extends ApplicationViewTab

EventTool contains the tool(s) that are used to create an event tree.

Author:
Tapio Keränen, t.tapio.keranen@student.jyu.fi
See Also:
Serialized Form
 

Nested Class Summary
static class EventTool.NODE_MODES
          The enum that contains the node modes used by the event tool.
 
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractComponent.ComponentErrorEvent, com.vaadin.ui.AbstractComponent.ComponentErrorHandler
 
Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer
com.vaadin.ui.ComponentContainer.ComponentAttachEvent, com.vaadin.ui.ComponentContainer.ComponentAttachListener, com.vaadin.ui.ComponentContainer.ComponentDetachEvent, com.vaadin.ui.ComponentContainer.ComponentDetachListener
 
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.ErrorListener, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener
 
Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable
com.vaadin.terminal.Paintable.RepaintRequestEvent, com.vaadin.terminal.Paintable.RepaintRequestListener
 
Field Summary
 
Fields inherited from class fi.paatti.research.paattiapplication.views.ApplicationViewTab
view
 
Fields inherited from interface com.vaadin.terminal.Sizeable
SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
 
Constructor Summary
EventTool(ApplicationView view, PaattiResearchApplication app)
          EventTool constructor.
 
Method Summary
 void buttonClick(com.vaadin.ui.Button.ClickEvent event)
          Handles the tab's button click events.
protected  void clearTab()
          Clears all information from the tab.
protected  void createLayout()
          Creates layout for the tab.
protected  void fillTab(com.vaadin.data.Item event)
          Fills the tab's fields with the item's information.
protected static com.vaadin.data.Item getChoiceItemFromContainer(Object containsTaskId, Object sequence, com.vaadin.data.util.sqlcontainer.SQLContainer choiceContainer)
          Returns the choice item that matches given parameters containsTaskId and sequence.
protected static com.vaadin.data.Item getEventItemFromContainer(Object eventId, com.vaadin.data.util.sqlcontainer.SQLContainer eventContainer)
          Returns the event item that matches the given id.
protected  NodeFactory.TreeNode getNodeByRealId(Object value)
          Returns the node with the matching real id (db row id).
protected static com.vaadin.data.Item getTaskItemFromContainer(Object taskId, com.vaadin.data.util.sqlcontainer.SQLContainer taskContainer)
          Returns the task item that matches the given id.
protected  String getWarningMessage()
          Returns the warning message set when checking the tree for malformed paths in the method isUnfinished().
protected  boolean isUnfinished()
          Checks the "tree" for incorrect values and malformed paths.
 void repaint()
          Requests for the canvas to repaint itself and for a new image file to be created.
 Object saveEventTree(Object eventId, String title, String description, Object eventTypeId, Integer estimatedTime)
          Saves the contents of the current event tree.
 
Methods inherited from class fi.paatti.research.paattiapplication.views.ApplicationViewTab
setContents
 
Methods inherited from class com.vaadin.ui.CustomComponent
addComponent, getComponentCount, getComponentIterator, getComponentType, getCompositionRoot, moveComponentsFrom, paintContent, removeAllComponents, removeComponent, replaceComponent, setComponentType, setCompositionRoot
 
Methods inherited from class com.vaadin.ui.AbstractComponentContainer
addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, removeListener, removeListener, requestRepaintAll, setEnabled, setHeight, setWidth
 
Methods inherited from class com.vaadin.ui.AbstractComponent
addListener, addListener, addListener, addListener, addListener, addStyleName, changeVariables, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidthUnits
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, childRequestedRepaint, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setIcon, setParent, setReadOnly, setStyleName, setVisible
 
Methods inherited from interface com.vaadin.terminal.Paintable
addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId
 
Methods inherited from interface com.vaadin.terminal.VariableOwner
changeVariables, isImmediate
 
Methods inherited from interface com.vaadin.terminal.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUnits
 

Constructor Detail

EventTool

public EventTool(ApplicationView view,
                 PaattiResearchApplication app)
EventTool constructor.

Parameters:
view - a parent view.
app - a handle to the main application.
Method Detail

createLayout

protected void createLayout()
Creates layout for the tab.

Specified by:
createLayout in class ApplicationViewTab

fillTab

protected void fillTab(com.vaadin.data.Item event)
Fills the tab's fields with the item's information.

Specified by:
fillTab in class ApplicationViewTab
Parameters:
event - db event item

clearTab

protected void clearTab()
Clears all information from the tab.

Clearing a tab resets the current event tree. Once the tree has been reset, a default root node is added to the tree to make sure an event always starts with a root node.

Specified by:
clearTab in class ApplicationViewTab

saveEventTree

public Object saveEventTree(Object eventId,
                            String title,
                            String description,
                            Object eventTypeId,
                            Integer estimatedTime)
Saves the contents of the current event tree.

Parameters:
title - the event's title
description - the event's description
eventId - the event's schedule id
eventTypeId - the event's type id
estimatedTime - the event's estimated time
Returns:
the event's row id

getEventItemFromContainer

protected static com.vaadin.data.Item getEventItemFromContainer(Object eventId,
                                                                com.vaadin.data.util.sqlcontainer.SQLContainer eventContainer)
Returns the event item that matches the given id. If the container does not have an item with the given id, a new SQLContainer item is created and returned instead.

Parameters:
eventId - the id of the event item to look for.
eventContainer - the SQL container with the event information.
Returns:
the old item if found; otherwise a new SQLContainer item.

getTaskItemFromContainer

protected static com.vaadin.data.Item getTaskItemFromContainer(Object taskId,
                                                               com.vaadin.data.util.sqlcontainer.SQLContainer taskContainer)
Returns the task item that matches the given id. If the container does not have an item with the given id, a new SQLContainer item is created and returned instead.

Parameters:
taskId - the id of the task item to look for.
taskContainer - the SQL container with the task information.
Returns:
the old item if found; otherwise a new SQLContainer item.

getChoiceItemFromContainer

protected static com.vaadin.data.Item getChoiceItemFromContainer(Object containsTaskId,
                                                                 Object sequence,
                                                                 com.vaadin.data.util.sqlcontainer.SQLContainer choiceContainer)
Returns the choice item that matches given parameters containsTaskId and sequence.

Parameters:
containsTaskId - the id of the choice item to look for.
sequence - the sequence if the choice item to look for.
choiceContainer - an SQL container with the choice information.
Returns:
old item if found; otherwise a new item.

getNodeByRealId

protected NodeFactory.TreeNode getNodeByRealId(Object value)
Returns the node with the matching real id (db row id).

Parameters:
value - the id of the node to look for.
Returns:
the matching node if found; otherwise null.

isUnfinished

protected boolean isUnfinished()
Checks the "tree" for incorrect values and malformed paths. A warning message is set if

1. the tree is empty (containing just the root node),
2. a MultiPathNode has no NodePaths added to it,
3. one of the NodePath values (desc, value, destination) is invalid, or
4. a node has no parent (excluding the root node).

Returns:
True if any defects are found, otherwise false.

getWarningMessage

protected String getWarningMessage()
Returns the warning message set when checking the tree for malformed paths in the method isUnfinished().

Returns:
The warning (error) message.

repaint

public void repaint()
Requests for the canvas to repaint itself and for a new image file to be created.


buttonClick

public void buttonClick(com.vaadin.ui.Button.ClickEvent event)
Handles the tab's button click events.

Unused method inherited from ApplicationViewTab.

Specified by:
buttonClick in interface com.vaadin.ui.Button.ClickListener
Specified by:
buttonClick in class ApplicationViewTab
Parameters:
event - click event.


Copyright © 2012. All Rights Reserved.