[Tynstep-svn] r174 - in trunk/step-web-app: . src/main/java/com/tyndalehouse/step/web/client/bundles src/main/java/com/tyndalehouse/step/web/client/event src/main/java/com/tyndalehouse/step/web/client/eventhandler src/main/java/com/tyndalehouse/step/web/client/framework src/main/java/com/tyndalehouse/step/web/client/framework/gin src/main/java/com/tyndalehouse/step/web/client/framework/utils src/main/java/com/tyndalehouse/step/web/client/presenter src/main/java/com/tyndalehouse/step/web/client/presenter/display src/main/java/com/tyndalehouse/step/web/client/toolkit src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/events src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets src/main/java/com/tyndalehouse/step/web/client/view src/test/java/com/tyndalehouse/step src/test/java/com/tyndalehouse/step/web/client/presenter
ChrisBurrell at crosswire.org
ChrisBurrell at crosswire.org
Fri Aug 27 05:34:09 MST 2010
Author: ChrisBurrell
Date: 2010-08-27 05:34:09 -0700 (Fri, 27 Aug 2010)
New Revision: 174
Added:
trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/PassagePresenterTest.java
Removed:
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/DictionaryDefinitionFoundEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/DictionaryDefinitionFoundHandler.java
trunk/step-web-app/src/test/java/com/tyndalehouse/step/db/
Modified:
trunk/step-web-app/pom.xml
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/bundles/StepResources.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimebandListUpdateRequiredEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimelineScrollEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/UserInterestInBandEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimebandListUpdateRequiredEventHandler.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimelineScrollEventHandler.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/UserInterestInBandEventHandler.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepEventBus.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepViewInterface.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/gin/StepClientModule.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/ArrayUtils.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/DecoratorUtils.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/OsisUtils.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/StringUtils.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/FilterResultsPresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ModuleSideBarPresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/PassagePresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ScripturePresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/StepPresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimebandListPresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimelinePresenter.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/BookmarkDisplay.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/PassageDisplay.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/ScriptureDisplay.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/TimebandListDisplay.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HasSource.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HtmlList.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SimpleListBox.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SourceListBox.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/BookmarkHandlerImpl.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/OptionEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TapeTrack.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEvent.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEventDescriptor.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeScale.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeband.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeline.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/Orientation.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimebandRequestWindow.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimelineConstants.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/events/TimelineMouseHandler.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/CannotDeleteEventException.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/IncapableOfCalculatingRequestWindowException.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/TimeBandNotFoundException.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/UnknownFiredElement.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/CurrentBandStats.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/TimeConversionUtil.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/BibleVersionsDropDownComposite.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/OptionsButtonComposite.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/VerseLabel.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/BookmarkView.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/PassageView.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/ScriptureView.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/StepView.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimebandListView.java
trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimelineView.java
trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenterTest.java
trunk/step-web-app/step.launch
Log:
major refactor
Modified: trunk/step-web-app/pom.xml
===================================================================
--- trunk/step-web-app/pom.xml 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/pom.xml 2010-08-27 12:34:09 UTC (rev 174)
@@ -4,35 +4,24 @@
<groupId>com.tyndalehouse</groupId>
<artifactId>step-parent</artifactId>
<version>0.1-SNAPSHOT</version>
- <relativePath>..</relativePath>
+ <relativePath>../step-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.tyndalehouse</groupId>
<artifactId>step-web-app</artifactId>
<packaging>war</packaging>
- <name>step-web-app</name>
+ <name>STEP :: Web Application - Client UI code</name>
- <properties>
- <!--
- this is because the maven gwt plugin apparently has a hard-coded path
- to /war
- -->
-<!-- <war.directory>${basedir}/war</war.directory> -->
- <!-- <output.directory>${basedir}/war/WEB-INF/classes</output.directory> -->
- </properties>
-
<dependencies>
<dependency>
<groupId>com.tyndalehouse</groupId>
<artifactId>step-web-shared</artifactId>
- <version>${project.version}</version>
</dependency>
-
+
<dependency>
<groupId>com.tyndalehouse</groupId>
<artifactId>step-web-server</artifactId>
- <version>${project.version}</version>
</dependency>
<!--
@@ -44,8 +33,8 @@
</dependency>
<dependency>
- <groupId>com.googlecode.mvp4g</groupId>
- <artifactId>mvp4g</artifactId>
+ <groupId>com.googlecode.mvp4g</groupId>
+ <artifactId>mvp4g</artifactId>
</dependency>
<dependency>
@@ -59,8 +48,8 @@
<artifactId>gwt-dev</artifactId>
<scope>provided</scope>
</dependency>
-
+
<dependency>
<groupId>com.googlecode.gwt.inject</groupId>
<artifactId>gin</artifactId>
@@ -72,13 +61,13 @@
<artifactId>gwt-dispatch</artifactId>
</dependency>
- <!-- to be removed once we get rid of this -->
+ <!-- to be removed once we get rid of this -->
<dependency>
<groupId>com.google.code.gwt-log</groupId>
<artifactId>gwt-log</artifactId>
</dependency>
-<!-- to be removed if we can rewrite timeline without it -->
+ <!-- to be removed if we can rewrite timeline without it -->
<dependency>
<groupId>com.extjs</groupId>
<artifactId>gxt</artifactId>
@@ -96,21 +85,18 @@
<artifactId>jmock-junit4</artifactId>
<scope>test</scope>
</dependency>
-
- <!-- TO DO MOVE TO DEPENDENCY MANAGEMENT -->
- <dependency>
- <groupId>org.mockito</groupId>
- <artifactId>mockito-core</artifactId>
- <version>1.8.5</version>
- <scope>test</scope>
- </dependency>
-
+
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ </dependency>
+
</dependencies>
-
+
<build>
-
-
+
+
<resources>
<resource>
<directory>src/main/java</directory>
@@ -122,15 +108,11 @@
<directory>src/main/webapp</directory>
</resource>
</resources>
-
- <!-- <outputDirectory>${output.directory}</outputDirectory> -->
+
<plugins>
-
-
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
- <version>1.1.1</version>
<configuration>
<executable>java</executable>
<classpathScope>compile</classpathScope>
@@ -154,50 +136,10 @@
</execution>
</executions>
</plugin>
-
- <!--
+
<plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>gwt-maven-plugin</artifactId>
- <version>1.2</version>
- <configuration>
- <gwtVersion>${gwt.version}</gwtVersion>
- <runTarget>step/Step.html</runTarget>
- <inplace>true</inplace>
- <warSourceDirectory>${war.directory}</warSourceDirectory>
- <webappDirectory>${war.directory}</webappDirectory>
- <extraJvmArgs>-Xmx1024m -Dconnection.string="${db.connection.string}" -Ddb.driver=${db.driver}</extraJvmArgs>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>compile</goal>
- </goals>
- </execution>
- </executions>
- <dependencies>
- <dependency>
- <groupId>com.google.gwt</groupId>
- <artifactId>gwt-dev</artifactId>
- <version>${gwt.version}</version>
- </dependency>
- </dependencies>
- </plugin>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <warSourceDirectory>${war.directory}</warSourceDirectory>
- <webappDirectory>${war.directory}</webappDirectory>
- <webXml>${war.directory}/WEB-INF/web.xml</webXml>
- </configuration>
- </plugin>
- -->
-
- <plugin>
<groupId>org.mortbay.jetty</groupId>
<artifactId>maven-jetty-plugin</artifactId>
- <version>6.1.22</version>
<configuration>
<webAppSourceDirectory>${war.directory}</webAppSourceDirectory>
<webApp>${project.build.directory}/${project.build.finalName}.war</webApp>
@@ -222,8 +164,8 @@
</configuration>
</plugin>
<plugin>
+ <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
- <version>2.4</version>
<configuration>
<filesets>
<fileset>
@@ -240,7 +182,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
- <version>2.5</version>
<configuration>
<systemPropertyVariables>
<db.driver>${db.driver}</db.driver>
@@ -253,69 +194,41 @@
</includes>
</configuration>
</plugin>
- <plugin>
- <groupId>org.codehaus.mojo</groupId>
- <artifactId>cobertura-maven-plugin</artifactId>
- <version>2.3</version>
- <configuration>
- <check>
- <branchRate>85</branchRate>
- <lineRate>85</lineRate>
- <haltOnFailure>false</haltOnFailure>
- <totalBranchRate>60</totalBranchRate>
- <totalLineRate>60</totalLineRate>
- <packageLineRate>60</packageLineRate>
- <packageBranchRate>60</packageBranchRate>
- <!--
- <regexes> <regex>
- <pattern>com.example.reallyimportant.*</pattern>
- <branchRate>90</branchRate> <lineRate>80</lineRate> </regex>
- <regex> <pattern>com.example.boringcode.*</pattern>
- <branchRate>40</branchRate> <lineRate>30</lineRate> </regex>
- </regexes>
- -->
- </check>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>clean</goal>
- <goal>check</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
</plugins>
-
+
<pluginManagement>
<plugins>
<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-eclipse-plugin</artifactId>
- <configuration>
- <additionalProjectnatures>
- <projectnature>com.google.gwt.eclipse.core.gwtNature</projectnature>
- <projectnature>com.google.gdt.eclipse.core.webAppNature</projectnature>
- </additionalProjectnatures>
- <additionalBuildcommands>
- <buildCommand>
- <name>com.google.gwt.eclipse.core.gwtProjectValidator</name>
- <arguments>
- </arguments>
- <name>com.google.gdt.eclipse.core.webAppProjectValidator</name>
- <arguments>
- </arguments>
- </buildCommand>
- </additionalBuildcommands>
- <classpathContainers>
- <classpathContainer>org.eclipse.jdt.launching.JRE_CONTAINER</classpathContainer>
- <classpathContainer>com.google.gwt.eclipse.core.GWT_CONTAINER</classpathContainer>
- </classpathContainers>
- <!-- <buildOutputDirectory>war/WEB-INF/classes</buildOutputDirectory> -->
- </configuration>
- </plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-eclipse-plugin</artifactId>
+ <configuration>
+ <additionalProjectnatures>
+ <projectnature>com.google.gwt.eclipse.core.gwtNature</projectnature>
+ <projectnature>com.google.gdt.eclipse.core.webAppNature</projectnature>
+ </additionalProjectnatures>
+ <additionalBuildcommands>
+ <buildCommand>
+ <name>com.google.gwt.eclipse.core.gwtProjectValidator</name>
+ <arguments>
+ </arguments>
+ <name>com.google.gdt.eclipse.core.webAppProjectValidator</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </additionalBuildcommands>
+ <classpathContainers>
+ <classpathContainer>org.eclipse.jdt.launching.JRE_CONTAINER</classpathContainer>
+ <classpathContainer>com.google.gwt.eclipse.core.GWT_CONTAINER</classpathContainer>
+ </classpathContainers>
+ <excludes>
+ <exclude>com.google.gwt:gwt-servlet</exclude>
+ <exclude>com.google.gwt:gwt-user</exclude>
+ <exclude>com.google.gwt:gwt-dev</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
</plugins>
</pluginManagement>
-
+
</build>
</project>
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/bundles/StepResources.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/bundles/StepResources.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/bundles/StepResources.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -7,7 +7,7 @@
import com.tyndalehouse.step.web.client.bundles.css.Passage;
public interface StepResources extends ClientBundle {
- public static final StepResources RESOURCES = GWT.create(StepResources.class);
+ StepResources RESOURCES = GWT.create(StepResources.class);
// @Source("com/tyndalehouse/step/web/client/sidebar/people.png")
// ImageResource peopleModule();
Deleted: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/DictionaryDefinitionFoundEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/DictionaryDefinitionFoundEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/DictionaryDefinitionFoundEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,60 +0,0 @@
-package com.tyndalehouse.step.web.client.event;
-
-import com.google.gwt.event.shared.GwtEvent;
-import com.tyndalehouse.step.web.client.eventhandler.DictionaryDefinitionFoundHandler;
-
-/**
- * The dictionary definition found event. This is fired when the server has
- * responded with a dictionary definition and different parts of the system may
- * require notification of it.
- *
- * @author cjburrell TODO remove when implemented elsewhere
- */
- at Deprecated
-public class DictionaryDefinitionFoundEvent extends GwtEvent<DictionaryDefinitionFoundHandler> {
- /**
- * The default Type Handler Type is parameterized by the handler type in
- * order to make the addHandler method type safe.
- */
- private static Type<DictionaryDefinitionFoundHandler> TYPE = new Type<DictionaryDefinitionFoundHandler>();
-
- /**
- * the definition that was retrieved
- */
- private String definition;
-
- /**
- * default constructor
- *
- * @param defintion
- * this is the definition that was retrieved from the server
- */
- public DictionaryDefinitionFoundEvent(final String defintion) {
- this.definition = defintion;
- }
-
- @Override
- public Type<DictionaryDefinitionFoundHandler> getAssociatedType() {
- return DictionaryDefinitionFoundEvent.TYPE;
- }
-
- /**
- * @return the definition
- */
- public String getDefinition() {
- return definition;
- }
-
- /**
- * @param definition
- * the definition to set
- */
- public void setDefinition(final String definition) {
- this.definition = definition;
- }
-
- @Override
- protected void dispatch(final DictionaryDefinitionFoundHandler handler) {
- handler.onDefinitionFound(this);
- }
-}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimebandListUpdateRequiredEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimebandListUpdateRequiredEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimebandListUpdateRequiredEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -7,8 +7,8 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.helpers.CurrentBandStats;
/**
- * Event signalling that the timebands have been changed and an update is
- * required from any component keeping track of counts
+ * Event signalling that the timebands have been changed and an update is required from any component keeping track of
+ * counts
*
* @author cjburrell TODO remove when implemented elsewhere
*/
@@ -16,8 +16,8 @@
public class TimebandListUpdateRequiredEvent extends GwtEvent<TimebandListUpdateRequiredEventHandler> {
/**
- * The default Type Handler Type is parameterized by the handler type in
- * order to make the addHandler method type safe.
+ * The default Type Handler Type is parameterized by the handler type in order to make the addHandler method type
+ * safe.
*/
public static Type<TimebandListUpdateRequiredEventHandler> TYPE = new Type<TimebandListUpdateRequiredEventHandler>();
@@ -27,11 +27,9 @@
private final List<CurrentBandStats> stats;
/**
- * The timeline is passed in, so that the timeband list can know what the
- * new values are
+ * The timeline is passed in, so that the timeband list can know what the new values are
*
- * @param stats
- * timeline to be passed in
+ * @param stats timeline to be passed in
*/
public TimebandListUpdateRequiredEvent(final List<CurrentBandStats> stats) {
this.stats = stats;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimelineScrollEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimelineScrollEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/TimelineScrollEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -8,22 +8,21 @@
import com.tyndalehouse.step.web.shared.common.timeline.TimeBandVisibleDate;
/**
- * Event signalling the timeline has been scrolled. This event contains the list
- * of timebands, and the portions of those that need updating
+ * Event signalling the timeline has been scrolled. This event contains the list of timebands, and the portions of those
+ * that need updating
*
* @author cjburrell TODO remove when implemented elsewhere
*/
@Deprecated
public class TimelineScrollEvent extends GwtEvent<TimelineScrollEventHandler> {
/**
- * The default Type Handler Type is parameterized by the handler type in
- * order to make the addHandler method type safe.
+ * The default Type Handler Type is parameterized by the handler type in order to make the addHandler method type
+ * safe.
*/
public static Type<TimelineScrollEventHandler> TYPE = new Type<TimelineScrollEventHandler>();
/**
- * list of requests to the server on which portions of which bands need to
- * be updated
+ * list of requests to the server on which portions of which bands need to be updated
*/
private List<TimeBandVisibleDate> timebandVisibleDates;
@@ -37,12 +36,9 @@
/**
* adds a timeband and the portion of time that needs updating
*
- * @param timebandId
- * the timeband id
- * @param minDate
- * the minimum date
- * @param maxDate
- * the maximum date
+ * @param timebandId the timeband id
+ * @param minDate the minimum date
+ * @param maxDate the maximum date
*/
public void addTimebandVisibleDate(final int timebandId, final long minDate, final long maxDate) {
final TimeBandVisibleDate visibleDate = new TimeBandVisibleDate(timebandId, minDate, maxDate);
@@ -52,9 +48,8 @@
/**
* adds a @see {@link TimeBandVisibleDate} to the event
*
- * @param visibleDate
- * the TimeBandVisibleDate object containing details of which
- * parts of the timeband (min, max) need updating.
+ * @param visibleDate the TimeBandVisibleDate object containing details of which parts of the timeband (min, max)
+ * need updating.
*/
public void addTimebandVisibleDate(final TimeBandVisibleDate visibleDate) {
if (!visibleDate.isNoRequest()) {
@@ -75,8 +70,7 @@
}
/**
- * @param timebandVisibleDates
- * the timebandVisibleDates to set
+ * @param timebandVisibleDates the timebandVisibleDates to set
*/
public void setTimebandVisibleDates(final List<TimeBandVisibleDate> timebandVisibleDates) {
this.timebandVisibleDates = timebandVisibleDates;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/UserInterestInBandEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/UserInterestInBandEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/event/UserInterestInBandEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -11,8 +11,8 @@
@Deprecated
public class UserInterestInBandEvent extends GwtEvent<UserInterestInBandEventHandler> {
/**
- * The default Type Handler Type is parameterized by the handler type in
- * order to make the addHandler method type safe.
+ * The default Type Handler Type is parameterized by the handler type in order to make the addHandler method type
+ * safe.
*/
public static Type<UserInterestInBandEventHandler> TYPE = new Type<UserInterestInBandEventHandler>();
@@ -29,10 +29,8 @@
/**
* creates the event
*
- * @param bandId
- * the band that the user selected
- * @param isOfInterest
- * whether the user is interested in it or not
+ * @param bandId the band that the user selected
+ * @param isOfInterest whether the user is interested in it or not
*/
public UserInterestInBandEvent(final int bandId, final Boolean isOfInterest) {
this.bandId = bandId;
Deleted: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/DictionaryDefinitionFoundHandler.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/DictionaryDefinitionFoundHandler.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/DictionaryDefinitionFoundHandler.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,25 +0,0 @@
-package com.tyndalehouse.step.web.client.eventhandler;
-
-import com.google.gwt.event.shared.EventHandler;
-import com.tyndalehouse.step.web.client.event.DictionaryDefinitionFoundEvent;
-
-/**
- * This contract is relevant to any handler who wants to be notified when a
- * definition was looked up from the server TODO remove when implemented
- * elsewhere
- *
- * @author cjburrell
- *
- */
- at Deprecated
-public interface DictionaryDefinitionFoundHandler extends EventHandler {
- /**
- * This method is fired when a dictionary definition has been looked up from
- * the server
- *
- * @param dictionaryDefintionFoundEvent
- * the dictionary definition found event, containing the results
- * from the server
- */
- void onDefinitionFound(DictionaryDefinitionFoundEvent dictionaryDefintionFoundEvent);
-}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimebandListUpdateRequiredEventHandler.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimebandListUpdateRequiredEventHandler.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimebandListUpdateRequiredEventHandler.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -4,8 +4,8 @@
import com.tyndalehouse.step.web.client.event.TimebandListUpdateRequiredEvent;
/**
- * Contract for handlers requiring notification of updates to the number of
- * events on the timebands TODO: remove when implemented elsewhere
+ * Contract for handlers requiring notification of updates to the number of events on the timebands TODO: remove when
+ * implemented elsewhere
*
* @author cjburrell
*
@@ -13,11 +13,9 @@
@Deprecated
public interface TimebandListUpdateRequiredEventHandler extends EventHandler {
/**
- * This is fired when new events are added to the timeband, or when events
- * are no longer in the visible section
+ * This is fired when new events are added to the timeband, or when events are no longer in the visible section
*
- * @param timebandListUpdateRequiredEvent
- * the event containing the new statistics to be displayed
+ * @param timebandListUpdateRequiredEvent the event containing the new statistics to be displayed
*/
void onTimebandListRequiringUpdate(TimebandListUpdateRequiredEvent timebandListUpdateRequiredEvent);
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimelineScrollEventHandler.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimelineScrollEventHandler.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/TimelineScrollEventHandler.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -4,8 +4,8 @@
import com.tyndalehouse.step.web.client.event.TimelineScrollEvent;
/**
- * Contract for handlers wanting to be alerted when the timeline is being
- * scrolled TODO remove when implemented elsewhere
+ * Contract for handlers wanting to be alerted when the timeline is being scrolled TODO remove when implemented
+ * elsewhere
*
* @author cjburrell
*
@@ -14,12 +14,9 @@
public interface TimelineScrollEventHandler extends EventHandler {
/**
- * Fired when the timeline is being scrolled, before new events are
- * requested from the server
+ * Fired when the timeline is being scrolled, before new events are requested from the server
*
- * @param event
- * event containing the new portions of time to be requested from
- * the server
+ * @param event event containing the new portions of time to be requested from the server
*/
void onScroll(TimelineScrollEvent event);
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/UserInterestInBandEventHandler.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/UserInterestInBandEventHandler.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/eventhandler/UserInterestInBandEventHandler.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -4,8 +4,8 @@
import com.tyndalehouse.step.web.client.event.UserInterestInBandEvent;
/**
- * Contract for handlers requiring notifications of timebands being
- * selected/unselected TODO remove ehwne implemented elsewhere
+ * Contract for handlers requiring notifications of timebands being selected/unselected TODO remove ehwne implemented
+ * elsewhere
*
* @author cjburrell
*
@@ -16,9 +16,7 @@
/**
* fired when a timeband has been selected/nselected
*
- * @param userInterestInBandEvent
- * contains information about the timeband that was
- * selected/nselected
+ * @param userInterestInBandEvent contains information about the timeband that was selected/nselected
*/
void onUserInterestedInBand(UserInterestInBandEvent userInterestInBandEvent);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepEventBus.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepEventBus.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepEventBus.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -50,8 +50,7 @@
/**
* sets the new module to be looked up
*
- * @param selectedModule
- * the type of new module
+ * @param selectedModule the type of new module
*/
@Event(handlers = { FilterResultsPresenter.class, StepPresenter.class, FilterResultsPresenter.class })
void moduleChanged(SideBarModule selectedModule);
@@ -59,9 +58,7 @@
/**
* when the timeband is updated
*
- * @param currentBandStats
- * a list of stats that have reflect the latest status of the
- * timeband
+ * @param currentBandStats a list of stats that have reflect the latest status of the timeband
*/
@Event()
void timebandUpdated(List<CurrentBandStats> currentBandStats);
@@ -69,8 +66,7 @@
/**
* alerts of an update to the reference that the user is wanting to study
*
- * @param newReference
- * a new reference
+ * @param newReference a new reference
*/
@Event(handlers = { ScripturePresenter.class })
void scriptureChanged(String newReference, ScripturePresenterPosition position);
@@ -78,18 +74,15 @@
/**
* requests all words associated with a set of lemmas to be highlighted
*
- * @param lemmas
- * the list of lemmas
+ * @param lemmas the list of lemmas
*/
@Event(handlers = { PassagePresenter.class, StrongDefinitionPresenter.class })
void selectedLemmas(String[] lemmas);
/**
- * alerts the UI that a scripture has been retrieved successfully from the
- * server
+ * alerts the UI that a scripture has been retrieved successfully from the server
*
- * @param reference
- * of the passage
+ * @param reference of the passage
*
*/
// IMPROVEMENT we can have this show the user-entered reference if we want
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepViewInterface.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepViewInterface.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/StepViewInterface.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -3,8 +3,8 @@
import com.google.gwt.user.client.ui.Widget;
/**
- * All views should implement this interface, so that the presenters do not need
- * a reference to Widget and can be tested independently from the browser.
+ * All views should implement this interface, so that the presenters do not need a reference to Widget and can be tested
+ * independently from the browser.
*
* @author cjburrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/gin/StepClientModule.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/gin/StepClientModule.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/gin/StepClientModule.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -7,8 +7,8 @@
import com.google.inject.Singleton;
/**
- * Gin configuration for the the step client. In addition to normal guice
- * operations, this binds presenters to their views
+ * Gin configuration for the the step client. In addition to normal guice operations, this binds presenters to their
+ * views
*
* @author cjburrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/ArrayUtils.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/ArrayUtils.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/ArrayUtils.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -4,8 +4,7 @@
/**
* returns true if array is null or length == 0
*
- * @param o
- * the array
+ * @param o the array
* @return true if array is null or length == 0
*/
public boolean isEmpty(final Object[] o) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/DecoratorUtils.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/DecoratorUtils.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/DecoratorUtils.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -2,11 +2,11 @@
import static java.lang.Integer.valueOf;
-public class DecoratorUtils {
+public final class DecoratorUtils {
/** The string representation of a pixel */
private static final String PIXEL_UNIT = "px";
/** default padding to assign */
- private final static int DECORATOR_PADDING = 10;
+ private static final int DECORATOR_PADDING = 10;
/**
* hiding implementation
@@ -17,8 +17,7 @@
/**
* removes the last part of the dimension and adjusts
*
- * @param dimension
- * dimension to be adjusted for padding
+ * @param dimension dimension to be adjusted for padding
* @return the new dimension
*/
public static String removePadding(final String dimension) {
@@ -29,7 +28,11 @@
return dimension;
}
- /** removes padding based on a double **/
+ /**
+ * removes padding based on a double
+ *
+ * @param dimension the dimension for which to remove padding from
+ **/
public static double removePadding(final double dimension) {
return dimension - DECORATOR_PADDING;
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/OsisUtils.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/OsisUtils.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/OsisUtils.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -8,7 +8,7 @@
* @author CJBurrell
*
*/
-public class OsisUtils {
+public final class OsisUtils {
private static final char OSIS_REFERENCE_SEPARATOR = '.';
/**
@@ -21,8 +21,7 @@
/**
* give an osisID, we extract and return the verse number
*
- * @param osisId
- * the osis id
+ * @param osisId the osis id
* @return the verse number
*/
public static String getVerseNumberFromOsisId(final String osisId) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/StringUtils.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/StringUtils.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/framework/utils/StringUtils.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,6 +1,6 @@
package com.tyndalehouse.step.web.client.framework.utils;
-public class StringUtils {
+public final class StringUtils {
/**
* hiding implementation
*/
@@ -9,8 +9,7 @@
}
/**
- * @param s
- * the string to evaluate
+ * @param s the string to evaluate
* @return true if s == null or s.length == 0
*/
public static boolean isEmpty(final String s) {
@@ -18,8 +17,7 @@
}
/**
- * @param s
- * the string to evaluate
+ * @param s the string to evaluate
* @return true if !(s == null or s.length == 0)
*/
public static boolean isNotEmpty(final String s) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -19,29 +19,34 @@
import com.tyndalehouse.step.web.client.toolkit.handlers.BookmarkHandler;
import com.tyndalehouse.step.web.client.view.BookmarkView;
+/**
+ * Presents the list of bookmarks to the user. The most recent bookmark will always be on top. So if it is already
+ * contained in the list, it is moved to the top.
+ *
+ * Clicking a bookmark should display it on all Scripture views. There is also the option of showing it on one side only
+ *
+ * @author CJBurrell
+ *
+ */
@Presenter(view = BookmarkView.class)
public class BookmarkPresenter extends BasePresenter<BookmarkDisplay, StepEventBus> {
/** IMPROVEMENT make bookmark capacity a user setting */
private static final int BOOKMARK_CAPACITY = 20;
/**
- * a list of bookmarks that are current displayed on the screen IMPROVEMENT
- * store in server side session or as a cookie
+ * a list of bookmarks that are current displayed on the screen IMPROVEMENT store in server side session or as a
+ * cookie
* */
private final List<String> currentBookmarks = new ArrayList<String>();
/**
* scripture changed successfully, so add it to the bookmarks
*
- * @param shortNameReference
- * the short name reference ot be displayed on the reference
- *
- * TODO: write presenter test for this! FIXME: issue since view
- * inserts at index 0 all the time, so inverted
+ * @param shortNameReference the short name reference ot be displayed on the reference
*/
public void onScriptureChangedSuccessfully(final String shortNameReference) {
// if bookmark already in there, then we move it
- for (int ii = 0; ii < currentBookmarks.size(); ii++) {
- if (currentBookmarks.get(ii).equals(shortNameReference)) {
+ for (int ii = 0; ii < this.currentBookmarks.size(); ii++) {
+ if (this.currentBookmarks.get(ii).equals(shortNameReference)) {
// we relocate the bookmark
safelyRemoveBookmark(ii);
safelyAddBookmark(shortNameReference);
@@ -56,24 +61,25 @@
safelyAddBookmark(shortNameReference);
}
+ /**
+ * adds a bookmark safely (i.e. keeps list in sync with view)
+ *
+ * @param shortNameReference the reference to be shown
+ */
void safelyAddBookmark(final String shortNameReference) {
- final BookmarkHandler bookmarkHandlers = view.addBookmark(shortNameReference);
- currentBookmarks.add(0, shortNameReference);
+ final BookmarkHandler bookmarkHandlers = this.view.addBookmark(shortNameReference);
+ this.currentBookmarks.add(0, shortNameReference);
addHandler(bookmarkHandlers.getLeftHandler(), shortNameReference, LEFT);
addHandler(bookmarkHandlers.getBothHandler(), shortNameReference, BOTH);
addHandler(bookmarkHandlers.getRightHandler(), shortNameReference, RIGHT);
-
}
/**
* adds a handler to change the scripture on a click of the bookmark
*
- * @param handler
- * the handler
- * @param shortNameReference
- * the reference to be loaded up
- * @param position
- * the presenter position that is targeted
+ * @param handler the handler
+ * @param shortNameReference the reference to be loaded up
+ * @param position the presenter position that is targeted
*/
// IMPROVEMENT: the event could contain the passage, and therefore, we
// could make these non-anonymous inner classes
@@ -82,21 +88,34 @@
return handler.addClickHandler(new ClickHandler() {
public void onClick(final ClickEvent arg0) {
- eventBus.scriptureChanged(shortNameReference, position);
+ BookmarkPresenter.this.eventBus.scriptureChanged(shortNameReference, position);
}
});
}
+ /**
+ * removes a bookmark from the view and the internal list
+ *
+ * @param ii
+ */
void safelyRemoveBookmark(final int ii) {
- view.removeBookmark(ii);
- currentBookmarks.remove(ii);
+ this.view.removeBookmark(ii);
+ this.currentBookmarks.remove(ii);
}
+ /**
+ * returns the current list of bookmarks
+ *
+ * @return the list of bookmarks
+ */
List<String> getCurrentBookmarks() {
- return currentBookmarks;
+ return this.currentBookmarks;
}
+ /**
+ * called on start of the applications
+ */
public void onStart() {
- eventBus.setCenterPanel(view);
+ this.eventBus.setCenterPanel(this.view);
}
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/FilterResultsPresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/FilterResultsPresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/FilterResultsPresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -14,14 +14,28 @@
public class FilterResultsPresenter extends BasePresenter<FilterResultsDisplay, StepEventBus> {
private final DispatchAsync dispatcher;
+ /**
+ * constructs a presenter
+ *
+ * @param dispatcher dispatcher to be used to send commands
+ */
@Inject
FilterResultsPresenter(final DispatchAsync dispatcher) {
this.dispatcher = dispatcher;
}
+ /**
+ * call when a different module has been selected
+ *
+ * @param newModule the new module that is selected
+ */
public void onModuleChanged(final SideBarModule newModule) {
+ // TODO implement at some point
}
+ /**
+ * On start of the application
+ */
public void onStart() {
super.eventBus.setFilterPanel(super.view);
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ModuleSideBarPresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ModuleSideBarPresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ModuleSideBarPresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -11,9 +11,8 @@
@Presenter(view = ModuleSideBarView.class)
public class ModuleSideBarPresenter extends BasePresenter<ModuleSideBarDisplay, StepEventBus> {
/**
- * fires the start of the module side bar. Should register events to alert
- * when the module has changed. This in turn should fire off changes in the
- * filter results if open, etc.
+ * fires the start of the module side bar. Should register events to alert when the module has changed. This in turn
+ * should fire off changes in the filter results if open, etc.
*/
public void onStart() {
super.eventBus.setSidebar(super.view);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/PassagePresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/PassagePresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/PassagePresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -48,17 +48,15 @@
private Passage passage;
/**
- * This map contains a list of all highlight widgets, keyed by their lemmas.
- * Since each lemma can be associated with multiple words, we associate it
- * with a list of them.
+ * This map contains a list of all highlight widgets, keyed by their lemmas. Since each lemma can be associated with
+ * multiple words, we associate it with a list of them.
* */
private final Map<String, List<HasClickAndHighlightHandlers>> highlightableWords = new HashMap<String, List<HasClickAndHighlightHandlers>>();
/**
* default constructor
*
- * @param dispatcher
- * to pass commands to the server
+ * @param dispatcher to pass commands to the server
*/
@Inject
PassagePresenter(final DispatchAsync dispatcher) {
@@ -69,21 +67,17 @@
/**
* changes the passage by doing a call to the server
*
- * @param newReference
- * the new reference to lookup
+ * @param newReference the new reference to lookup
*/
public void changePassage(final String newReference, final String currentlySelectedVersion) {
refreshViewFromServer(newReference, currentlySelectedVersion);
}
/**
- * refreshes the passage displayed on the screen without necessarily
- * querying the server
+ * refreshes the passage displayed on the screen without necessarily querying the server
*
- * @param oe
- * the option event that triggered this event
- * @param newVersion
- * version to be selected
+ * @param oe the option event that triggered this event
+ * @param newVersion version to be selected
*/
public void refreshPassage(final OptionEvent oe) {
if (!refreshIfDataAlreadyObtained(oe)) {
@@ -110,10 +104,8 @@
/**
* refreshes the view by calling the server
*
- * @param newReference
- * the reference to be displayed
- * @param newVersion
- * the version to select
+ * @param newReference the reference to be displayed
+ * @param newVersion the version to select
*/
void refreshViewFromServer(final String newReference, final String newVersion) {
if (isNotEmpty(newVersion) && isNotEmpty(newReference)) {
@@ -139,12 +131,10 @@
}
/**
- * renders the passage in the view, by doing all the business logic and
- * manipulation here, and letting the view do the display
+ * renders the passage in the view, by doing all the business logic and manipulation here, and letting the view do
+ * the display
*
- * @param selectedOptions
- * currently selected options defining the features to be
- * displayed on the passage
+ * @param selectedOptions currently selected options defining the features to be displayed on the passage
*
*/
void renderPassage() {
@@ -166,13 +156,10 @@
}
/**
- * renders individual passage elements onto the view, dependendant on their
- * type, etc.
+ * renders individual passage elements onto the view, dependendant on their type, etc.
*
- * @param passageElement
- * the passage element to be rendered, for e.g. a WORD
- * @param selectedOptions
- * the options that are currently selected in this view
+ * @param passageElement the passage element to be rendered, for e.g. a WORD
+ * @param selectedOptions the options that are currently selected in this view
*/
private void renderPassageElement(final PassageElement passageElement,
final Map<String, ScriptureDisplayOptions> selectedOptions) {
@@ -219,13 +206,10 @@
}
/**
- * business logic around translating a passage element into a word to be
- * displayed on the screen
+ * business logic around translating a passage element into a word to be displayed on the screen
*
- * @param passageElement
- * the passageElement
- * @param selectedOptions
- * the selectedOptions currently on the screen.
+ * @param passageElement the passageElement
+ * @param selectedOptions the selectedOptions currently on the screen.
*/
void doWord(final PassageElement passageElement, final Map<String, ScriptureDisplayOptions> selectedOptions) {
final String alternativeWording = passageElement.getAttribute(ALTERNATIVE_WORDING);
@@ -261,10 +245,8 @@
/**
* turns a list of osis, prefixed attributes into an array
*
- * @param attributeArray
- * the attribute array
- * @param prefix
- * the prefix of each attribute, which gets removed
+ * @param attributeArray the attribute array
+ * @param prefix the prefix of each attribute, which gets removed
* @return an array of attributes without the prefix
*/
String[] getArrayOfAttributes(final String attributeArray, final String prefix) {
@@ -282,10 +264,8 @@
/**
* safely adds a word to the highlightable map
*
- * @param lemma
- * the lemma associated to the word = the key of the map
- * @param wordHandler
- * a word which can be highlighted
+ * @param lemma the lemma associated to the word = the key of the map
+ * @param wordHandler a word which can be highlighted
*/
void addHighlitableWord(final String lemma, final HasClickAndHighlightHandlers wordHandler) {
if (wordHandler != null) {
@@ -302,8 +282,7 @@
/**
* highlights all the words in the highlightable map
*
- * @param lemmas
- * the list of lemmas associated with the clicked word
+ * @param lemmas the list of lemmas associated with the clicked word
*/
public void onSelectedLemmas(final String[] lemmas) {
final Set<String> lemmaSet = new HashSet<String>();
@@ -322,8 +301,7 @@
/**
* renders a quote on the passage view
*
- * @param passageElement
- * the element to render
+ * @param passageElement the element to render
*/
void doQuote(final PassageElement passageElement) {
final String markerAttribute = passageElement.getAttribute(OsisElementType.MARKER);
@@ -337,8 +315,7 @@
/**
* adds a verse number if other renderable items have been rendered
*
- * @param childVerseNode
- * the child node of a verse
+ * @param childVerseNode the child node of a verse
* @return true if the verse number was inserted
*/
boolean doVerseNumber(final String osisIdAttribute, final PassageElement childVerseNode) {
@@ -350,11 +327,10 @@
}
/**
- * returns the text from a passage element, which can either be stored
- * directly as text or as a TEXT node and then text
+ * returns the text from a passage element, which can either be stored directly as text or as a TEXT node and then
+ * text
*
- * @param passageElement
- * the passage element to retrieve text from
+ * @param passageElement the passage element to retrieve text from
* @return the text itself
*/
String getText(final PassageElement passageElement) {
@@ -371,11 +347,9 @@
}
/**
- * either does the refresh if it is possible, without asking the server or
- * return false
+ * either does the refresh if it is possible, without asking the server or return false
*
- * @param oe
- * the event triggering this refresh the selected option
+ * @param oe the event triggering this refresh the selected option
* @return true if a refresh was done
*/
boolean refreshIfDataAlreadyObtained(final OptionEvent oe) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ScripturePresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ScripturePresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/ScripturePresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -23,9 +23,8 @@
import com.tyndalehouse.step.web.shared.result.beans.BibleVersion;
/**
- * This presenter is responsible for displaying scripture to the user, in an
- * interactive way including the highlight-on-click, querying the server for
- * portions of text, etc.
+ * This presenter is responsible for displaying scripture to the user, in an interactive way including the
+ * highlight-on-click, querying the server for portions of text, etc.
*
* @author cjburrell
*
@@ -39,23 +38,17 @@
/** default asynchronous dispatcher */
private final DispatchAsync dispatcher;
/**
- * the location/id of this presenter, in terms of whether it should be
- * notified of all events
+ * the location/id of this presenter, in terms of whether it should be notified of all events
*/
private ScripturePresenterPosition position;
private PassagePresenter passagePresenter;
/**
*
- * @param display
- * the view, provided by Gin
- * @param eventBus
- * the event bus, provided by Gin
- * @param dispatcher
- * the dispatcher, provided by Gin
- * @param scriptureSelectorView
- * the scripture selector view (i.e. the bit with the reference
- * in it), provided by Gin
+ * @param display the view, provided by Gin
+ * @param eventBus the event bus, provided by Gin
+ * @param dispatcher the dispatcher, provided by Gin
+ * @param scriptureSelectorView the scripture selector view (i.e. the bit with the reference in it), provided by Gin
*/
@Inject
public ScripturePresenter(final DispatchAsync dispatcher) {
@@ -120,8 +113,7 @@
/**
*
- * @param position
- * sets the current position of the view
+ * @param position sets the current position of the view
*/
public void setScripturePresenterPosition(final ScripturePresenterPosition position) {
this.position = position;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/StepPresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/StepPresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/StepPresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -15,8 +15,7 @@
import com.tyndalehouse.step.web.client.view.StepView;
/**
- * This is the main Presenter, when the view is created, all other presenters
- * are created as a result.
+ * This is the main Presenter, when the view is created, all other presenters are created as a result.
*
* It acts as a singleton for each browser
*
@@ -37,8 +36,8 @@
view.setRightColumn(rightHandler.getView());
view.setTopLeftPanel(eventBus.addHandler(ScriptureSelectorPresenter.class).getView());
- final ScriptureSelectorDisplay rightScriptureSelector = eventBus.addHandler(
- ScriptureSelectorPresenter.class).getView();
+ final ScriptureSelectorDisplay rightScriptureSelector = eventBus.addHandler(ScriptureSelectorPresenter.class)
+ .getView();
view.setTopRightPanel(rightScriptureSelector);
rightScriptureSelector.setEnabled(false);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimebandListPresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimebandListPresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimebandListPresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -9,9 +9,8 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.helpers.CurrentBandStats;
/**
- * The TimebandList presenter is the presenter for the Timeband list module.
- * This module is a list of items, each one representing one timeband. Each item
- * contains the real-time statistics of what is displayed on the timeband,
+ * The TimebandList presenter is the presenter for the Timeband list module. This module is a list of items, each one
+ * representing one timeband. Each item contains the real-time statistics of what is displayed on the timeband,
* including the number of event and the number of events currently visible
*
* @author cjburrell
@@ -25,10 +24,8 @@
/**
* Default constructor, injected with Gin
*
- * @param display
- * the view, provided by Gin
- * @param eventBus
- * the event bus, provided by Gin
+ * @param display the view, provided by Gin
+ * @param eventBus the event bus, provided by Gin
*/
// TODO
// @Inject
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimelinePresenter.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimelinePresenter.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/TimelinePresenter.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -30,9 +30,8 @@
import com.tyndalehouse.step.web.shared.timeline.Unit;
/**
- * TimelinePresenter is the presenter object for the Timeline module This is
- * responsible for getting all the events from the server, firing changes across
- * the event bus, if need be, repainting the timeline module, etc.
+ * TimelinePresenter is the presenter object for the Timeline module This is responsible for getting all the events from
+ * the server, firing changes across the event bus, if need be, repainting the timeline module, etc.
*
* @author cjburrell
*
@@ -51,12 +50,9 @@
/**
* Constructor to set up the timeline module
*
- * @param display
- * the view, passed in by Gin
- * @param eventBus
- * the event bus, passed in by Gin
- * @param dispatcher
- * the dispatcher, passed in by Gin
+ * @param display the view, passed in by Gin
+ * @param eventBus the event bus, passed in by Gin
+ * @param dispatcher the dispatcher, passed in by Gin
*/
@Inject
public TimelinePresenter(final DispatchAsync dispatcher) {
@@ -92,9 +88,7 @@
/**
* sets up the timeline view, height, intial timebands, etc.
*
- * @param setupData
- * data returned from the server including all the timebands, and
- * their units, etc.
+ * @param setupData data returned from the server including all the timebands, and their units, etc.
*/
protected void setupTimeline(final GetTimelineUISetupResult setupData) {
final Timeline timeline = view.getTimeline();
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/BookmarkDisplay.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/BookmarkDisplay.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/BookmarkDisplay.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -9,10 +9,8 @@
/**
* adds a bookmark to the view display
*
- * @param shortNameReference
- * short name reference for e.g. Matt 1:1
- * @param referenceShortName
- * the
+ * @param shortNameReference short name reference for e.g. Matt 1:1
+ * @param referenceShortName the
* @param displayOptions
*/
BookmarkHandler addBookmark(String shortNameReference);
@@ -20,8 +18,7 @@
/**
* removes the bookmark stored at index
*
- * @param index
- * index of the bookmark to be removed
+ * @param index index of the bookmark to be removed
*/
void removeBookmark(int index);
}
\ No newline at end of file
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/PassageDisplay.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/PassageDisplay.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/PassageDisplay.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -41,16 +41,14 @@
/**
* creates a verse number
*
- * @param verseNumber
- * the verse number
+ * @param verseNumber the verse number
* */
void createVerseNumber(String verseNumber);
/**
* creates a lemma on the view
*
- * @param lemma
- * the lemma
+ * @param lemma the lemma
*/
void createLemmaTag(String lemma);
@@ -73,14 +71,10 @@
/**
* creates a four-lined interlinear word
*
- * @param text
- * the text to be displayed
- * @param alternativeWording
- * the word to be displayed as the alternative
- * @param lemmas
- * the lemmas associated with this word
- * @param morphs
- * the morphs associated with this word
+ * @param text the text to be displayed
+ * @param alternativeWording the word to be displayed as the alternative
+ * @param lemmas the lemmas associated with this word
+ * @param morphs the morphs associated with this word
* @return a handler to enable the highlighting of the word
*/
HasClickAndHighlightHandlers createInterlinearWord(String text, String alternativeWording, String[] lemmas,
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/ScriptureDisplay.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/ScriptureDisplay.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/ScriptureDisplay.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -16,14 +16,10 @@
/**
* adds a version to the display
*
- * @param contentType
- * the type of content this is, for example Bible
- * @param language
- * the language
- * @param versionInitials
- * the initials of the version
- * @param versionName
- * the version name
+ * @param contentType the type of content this is, for example Bible
+ * @param language the language
+ * @param versionInitials the initials of the version
+ * @param versionName the version name
*/
void addVersion(String contentType, String language, String versionInitials, String versionName);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/TimebandListDisplay.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/TimebandListDisplay.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/presenter/display/TimebandListDisplay.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -14,8 +14,7 @@
/**
* This method updates the list displayed with the latest statistics
*
- * @param stats
- * statistics to be sent to the view for update
+ * @param stats statistics to be sent to the view for update
*/
void updateList(List<CurrentBandStats> stats);
}
\ No newline at end of file
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HasSource.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HasSource.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HasSource.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,15 +1,13 @@
package com.tyndalehouse.step.web.client.toolkit;
/**
- * Indicates that the view (generally) has got a source, a dropdown list for
- * e.g.) and can be set
+ * Indicates that the view (generally) has got a source, a dropdown list for e.g.) and can be set
*
* TODO: remove class
*
* @author cjburrell
*
- * @param <T>
- * The type of data it is expecting
+ * @param <T> The type of data it is expecting
*/
@Deprecated
public interface HasSource<T> {
@@ -21,8 +19,7 @@
/**
* Settings the data
*
- * @param source
- * source of the data
+ * @param source source of the data
*/
void setSource(T source);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HtmlList.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HtmlList.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/HtmlList.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -11,8 +11,7 @@
import com.google.gwt.user.client.ui.Widget;
/**
- * A HTML list, taken partially from the web This can be ordered or unordered
- * TODO remove class
+ * A HTML list, taken partially from the web This can be ordered or unordered TODO remove class
*
* @author cjburrell
*/
@@ -63,16 +62,14 @@
}
/**
- * list of items to be mapped in the list. And whether they should launch
- * Commands on selected
+ * list of items to be mapped in the list. And whether they should launch Commands on selected
*/
private final Map<Element, Command> listItems = new HashMap<Element, Command>();
/**
* Constructor to create a HTML unordered or ordered list
*
- * @param listType
- * whether an ordered or unordered list should be created
+ * @param listType whether an ordered or unordered list should be created
*/
public HtmlList(final ListType listType) {
setElement(listType.createElement());
@@ -82,10 +79,8 @@
/**
* Adds an item to the HtmlList
*
- * @param text
- * the text next to the bullet/numbered point
- * @param command
- * the command to be executed if a user clicks on it
+ * @param text the text next to the bullet/numbered point
+ * @param command the command to be executed if a user clicks on it
*/
public void addItem(final String text, final Command command) {
final LIElement liElement = Document.get().createLIElement();
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SimpleListBox.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SimpleListBox.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SimpleListBox.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -5,8 +5,8 @@
import com.google.gwt.user.client.ui.ListBox;
/**
- * An extension to the GWT ListBox, mainly to allow the setSource method
- * exposure, and hide implementation details of the ListBox from the presenter
+ * An extension to the GWT ListBox, mainly to allow the setSource method exposure, and hide implementation details of
+ * the ListBox from the presenter
*
* @author cjburrell TODO remove if not used
*/
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SourceListBox.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SourceListBox.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/SourceListBox.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -6,8 +6,7 @@
import com.google.gwt.user.client.ui.ListBox;
/**
- * Similar to @see {@link SimpleListBox}, but the source is given as a HashMap
- * TODO remove class
+ * Similar to @see {@link SimpleListBox}, but the source is given as a HashMap TODO remove class
*
* @author cjburrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/BookmarkHandlerImpl.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/BookmarkHandlerImpl.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/BookmarkHandlerImpl.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -3,8 +3,7 @@
import com.google.gwt.event.dom.client.HasClickHandlers;
/**
- * A simple holder object that holds the three handlers created by a view when a
- * bookmark is created.
+ * A simple holder object that holds the three handlers created by a view when a bookmark is created.
*
* @author CJBurrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/OptionEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/OptionEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/handlers/OptionEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -3,22 +3,23 @@
import com.google.gwt.event.shared.GwtEvent;
import com.tyndalehouse.step.web.shared.common.ScriptureDisplayOptions;
+/**
+ * An event fired when an option is selected
+ *
+ * @author CJBurrell
+ *
+ */
public class OptionEvent extends GwtEvent<OptionHandler> {
- private static Type<OptionHandler> TYPE = new Type<OptionHandler>();
+ private final static Type<OptionHandler> TYPE = new Type<OptionHandler>();
private final ScriptureDisplayOptions selectedOption;
private final boolean addingData;
/**
- * creates an OptionEvent which indicates what feature is requested, and
- * whether we are adding data to the display, or removing it. Clearly, if we
- * are removing data, we don't need to do a call to the server
+ * creates an OptionEvent which indicates what feature is requested, and whether we are adding data to the display,
+ * or removing it. Clearly, if we are removing data, we don't need to do a call to the server
*
- * @param sdo
- * the option that is being toggled
- * @param addingData
- * whether the toggling needs more data than required.
- * @param selectedOptions
- * the current state of all selected options
+ * @param sdo the option that is being toggled
+ * @param addingData whether the toggling needs more data than required.
*/
public OptionEvent(final ScriptureDisplayOptions sdo, final boolean addingData) {
this.selectedOption = sdo;
@@ -30,6 +31,9 @@
handler.onOptionSelected(this);
}
+ /**
+ * @return the type associated with this event
+ */
public static Type<OptionHandler> getType() {
return TYPE;
}
@@ -43,13 +47,13 @@
* @return the selectedOption
*/
public ScriptureDisplayOptions getSelectedOption() {
- return selectedOption;
+ return this.selectedOption;
}
/**
* @return the addingData
*/
public boolean isAddingData() {
- return addingData;
+ return this.addingData;
}
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TapeTrack.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TapeTrack.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TapeTrack.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -5,17 +5,15 @@
import com.google.gwt.user.client.ui.Widget;
/**
- * A tape track is the track on which events are painted. The events are
- * contained by the TimeBand as that's where they logically reside. However,
- * they are painted on the timetracks.
+ * A tape track is the track on which events are painted. The events are contained by the TimeBand as that's where they
+ * logically reside. However, they are painted on the timetracks.
*
* @author cjburrell
*
*/
public class TapeTrack extends Widget {
/**
- * The following variable defines the earliest spot at which an event can be
- * painted
+ * The following variable defines the earliest spot at which an event can be painted
*/
private int earliestPaintOpportunity;
@@ -25,8 +23,8 @@
private boolean isRendered;
/**
- * The following spot defines the latest spot at which an event needs to be
- * finished if it is to be painted on this track
+ * The following spot defines the latest spot at which an event needs to be finished if it is to be painted on this
+ * track
*/
private int latestPaintOpportunity;
@@ -36,10 +34,9 @@
private final Element track;
/**
- * The default constructor initialises in memory a tape track. This includes
- * setting up the div outside of the DOM, and setting the default earliest
- * and latest opportunities for painting as Max and Min Integers hence
- * allowing everything to be painted
+ * The default constructor initialises in memory a tape track. This includes setting up the div outside of the DOM,
+ * and setting the default earliest and latest opportunities for painting as Max and Min Integers hence allowing
+ * everything to be painted
*/
public TapeTrack() {
isRendered = false;
@@ -52,11 +49,10 @@
}
/**
- * Checks and then adds an event to the timetrack Logically it is still
- * added to the band, but it is painted on the timetrack
+ * Checks and then adds an event to the timetrack Logically it is still added to the band, but it is painted on the
+ * timetrack
*
- * @param event
- * even to be painted
+ * @param event even to be painted
* @return whether the event has been painted
*/
public boolean addEvent(final TimeEvent event) {
@@ -79,14 +75,11 @@
}
/**
- * The events need to be added in order, otherwise the time taping will not
- * be efficient Returns whether an event of width width can be painted at
- * position pixel
+ * The events need to be added in order, otherwise the time taping will not be efficient Returns whether an event of
+ * width width can be painted at position pixel
*
- * @param pixel
- * pixel position at which to be painted
- * @param width
- * width of the event
+ * @param pixel pixel position at which to be painted
+ * @param width width of the event
* @return true if the event can be painted
*/
public boolean canPaintAt(final int pixel, final int width) {
@@ -103,8 +96,7 @@
/**
* paints the timetrack on to the timeband
*
- * @param band
- * the band to be painteds
+ * @param band the band to be painteds
*/
public void paint(final Timeband band) {
if (!isRendered) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEvent.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEvent.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEvent.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -36,8 +36,7 @@
private Element eventDiv;
/**
- * default to a standard event or duration we will drive this from the
- * database
+ * default to a standard event or duration we will drive this from the database
*/
private String eventType;
@@ -61,8 +60,7 @@
private Element label;
/**
- * The left-most position at which the event is located, in relation to the
- * timeband
+ * The left-most position at which the event is located, in relation to the timeband
*/
private int leftPixelPosition;
/**
@@ -82,9 +80,8 @@
private boolean showText;
/**
- * A representation of the total width occupied by the event, including the
- * text next to it. This is particularly important for events that are
- * single point in time, where the text will be much wider than the icon
+ * A representation of the total width occupied by the event, including the text next to it. This is particularly
+ * important for events that are single point in time, where the text will be much wider than the icon
*
*/
private int totalWidth;
@@ -92,17 +89,11 @@
/**
* The
*
- * @param id
- * id of the event
- * @param description
- * a description to be displayed
- * @param minDate
- * a minimum date
- * @param maxDate
- * a maximum date, optional, in case of single point in time
- * events
- * @param tb
- * the timeband
+ * @param id id of the event
+ * @param description a description to be displayed
+ * @param minDate a minimum date
+ * @param maxDate a maximum date, optional, in case of single point in time events
+ * @param tb the timeband
*/
public TimeEvent(final int id, final String description, final Long minDate, final Long maxDate, final Timeband tb) {
this.id = id;
@@ -234,8 +225,7 @@
/**
* the main responsible culprit for painting events on the timeband
*
- * @param track
- * the track on which the event will be painted
+ * @param track the track on which the event will be painted
*/
public void paint(final TapeTrack track) {
// all we do is attach it to the parent if need be.
@@ -259,72 +249,63 @@
}
/**
- * @param description
- * the description to set
+ * @param description the description to set
*/
public void setDescription(final String description) {
this.description = description;
}
/**
- * @param eventType
- * the eventType to set
+ * @param eventType the eventType to set
*/
public void setEventType(final String eventType) {
this.eventType = eventType;
}
/**
- * @param id
- * the id to set
+ * @param id the id to set
*/
public void setId(final int id) {
this.id = id;
}
/**
- * @param leftPixelPosition
- * the leftPixelPosition to set
+ * @param leftPixelPosition the leftPixelPosition to set
*/
public void setLeftPixelPosition(final int leftPixelPosition) {
this.leftPixelPosition = leftPixelPosition;
}
/**
- * @param maxDate
- * the maxDate to set
+ * @param maxDate the maxDate to set
*/
public void setMaxDate(final long maxDate) {
this.maxDate = maxDate;
}
/**
- * @param maxDate
- * the maxDate to set
+ * @param maxDate the maxDate to set
*/
public void setMaxDate(final Long maxDate) {
this.maxDate = maxDate;
}
/**
- * @param minDate
- * the minDate to set
+ * @param minDate the minDate to set
*/
public void setMinDate(final long minDate) {
this.minDate = minDate;
}
/**
- * @param minDate
- * the minDate to set
+ * @param minDate the minDate to set
*/
public void setMinDate(final Long minDate) {
this.minDate = minDate;
}
/**
- * @param showText
- * the showText to set
+ * @param showText the showText to set
*/
public void setShowText(final boolean showText) {
this.showText = showText;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEventDescriptor.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEventDescriptor.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeEventDescriptor.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -7,9 +7,8 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.components.TimelineConstants;
/**
- * There is only one TimeEvent descriptor for the timeline module. This is the
- * hover over the time event on the timeline module. For e.g. a user might over
- * a point in time event, and get a description of what/when it represents
+ * There is only one TimeEvent descriptor for the timeline module. This is the hover over the time event on the timeline
+ * module. For e.g. a user might over a point in time event, and get a description of what/when it represents
*
* @author cjburrell
*
@@ -34,8 +33,7 @@
/**
* public constructor initialising the descriptor
*
- * @param timeline
- * the timeline on which the popup is to be displayed
+ * @param timeline the timeline on which the popup is to be displayed
*/
public TimeEventDescriptor(final Timeline timeline) {
this.timeline = timeline;
@@ -66,11 +64,8 @@
/**
* Given a timed event, this shows the description in a div
*
- * @param te
- * the TimeEvent to be displayed
- * @param me
- * the mouse event that was triggered, contains details of pixel
- * positions
+ * @param te the TimeEvent to be displayed
+ * @param me the mouse event that was triggered, contains details of pixel positions
*/
public void show(final TimeEvent te, final MouseEvent<?> me) {
final El divWrapper = getDivWrapper();
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeScale.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeScale.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/TimeScale.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,6 +1,7 @@
package com.tyndalehouse.step.web.client.toolkit.timeline;
import java.util.HashMap;
+import java.util.Map;
import com.extjs.gxt.ui.client.core.El;
import com.google.gwt.user.client.DOM;
@@ -9,8 +10,8 @@
import com.tyndalehouse.step.web.shared.timeline.Unit;
/**
- * time scale, in charge of drawing the different columns on the timeband at
- * various lengths, dependant on the uni of the timeband
+ * time scale, in charge of drawing the different columns on the timeband at various lengths, dependant on the uni of
+ * the timeband
*
* @author CJBurrell
*
@@ -29,7 +30,7 @@
/**
* Maps of all timescales that have been drawn on the timeband
*/
- private final HashMap<Integer, Element> paintedTimescaleBands;
+ private final Map<Integer, Element> paintedTimescaleBands;
/**
* DOM element containing the scale columns
@@ -39,12 +40,11 @@
/**
* A timescale is attached to a timeband
*
- * @param band
- * timeband to attach the scale on
+ * @param band timeband to attach the scale on
*/
public TimeScale(final Timeband band) {
this.band = band;
- paintedTimescaleBands = new HashMap<Integer, Element>();
+ this.paintedTimescaleBands = new HashMap<Integer, Element>();
}
/**
@@ -52,19 +52,21 @@
*/
public void paint() {
// check band is rendered, otherwise this is a waste of time
- if (!band.isRendered()) {
+ if (!this.band.isRendered()) {
return;
}
// if rendered already? skip!
- if (!isRendered) {
- scaleBand = DOM.createDiv();
- paintedTimescaleBands.clear(); // reset in case we're in a zoom
+ if (!this.isRendered) {
+ this.scaleBand = DOM.createDiv();
- final El gxtScaleBand = new El(scaleBand);
- band.getBandDiv().appendChild(scaleBand);
+ // reset in case we're in a zoom
+ this.paintedTimescaleBands.clear();
+
+ final El gxtScaleBand = new El(this.scaleBand);
+ this.band.getBandDiv().appendChild(this.scaleBand);
gxtScaleBand.setStyleName("step-scale-band", true);
- isRendered = true;
+ this.isRendered = true;
}
// finally render those bits that are visible only
@@ -72,9 +74,8 @@
}
/**
- * The easy way is to get rid of everything and repaint The slightly more
- * clever way is to actually repaint the existing dom elements. It uses more
- * memory though, however, we can try both eventually if need be.
+ * The easy way is to get rid of everything and repaint The slightly more clever way is to actually repaint the
+ * existing dom elements. It uses more memory though, however, we can try both eventually if need be.
*/
public void repaint() {
// remove oneself first
@@ -86,20 +87,18 @@
* resets to redraw
*/
public void reset() {
- isRendered = false;
+ this.isRendered = false;
}
/**
* draws the segments on the TimeScale DOM element
*
- * @param firstVisibleSegmentPixel
- * first visible pixel, left most, of the band
- * @param numberOfVisibleSegments
- * number of segments to draw
+ * @param firstVisibleSegmentPixel first visible pixel, left most, of the band
+ * @param numberOfVisibleSegments number of segments to draw
*/
- private synchronized void drawSegments(final long firstVisibleSegmentPixel, final long numberOfVisibleSegments) {
- final El gxtScaleBand = new El(scaleBand);
- final int pixelsPerUnit = band.getPixelsPerUnit();
+ private void drawSegments(final long firstVisibleSegmentPixel, final long numberOfVisibleSegments) {
+ final El gxtScaleBand = new El(this.scaleBand);
+ final int pixelsPerUnit = this.band.getPixelsPerUnit();
int relativeLeft = (int) firstVisibleSegmentPixel;
// Log.debug("Drawing segments");
for (long ii = 0; ii < numberOfVisibleSegments + 1; ii++) {
@@ -113,13 +112,13 @@
// TODO: instead of relying on time for drawing these, draw the
// first one,
// then rely on intervals. Saves computations for storage.
- if (!paintedTimescaleBands.containsKey(key) && !paintedTimescaleBands.containsKey(keyPlus1)
- && !paintedTimescaleBands.containsKey(keyMinus1)) {
+ if (!this.paintedTimescaleBands.containsKey(key) && !this.paintedTimescaleBands.containsKey(keyPlus1)
+ && !this.paintedTimescaleBands.containsKey(keyMinus1)) {
final Element un = DOM.createDiv();
final El gxtUn = new El(un);
gxtUn.setWidth(pixelsPerUnit);
- un.setInnerText(TimeConversionUtil.formatPixelToTime(relativeLeft, band));
+ un.setInnerText(TimeConversionUtil.formatPixelToTime(relativeLeft, this.band));
gxtScaleBand.appendChild(un);
// set left position:
@@ -128,7 +127,7 @@
// makes sure it lines up to the top
gxtUn.setHeight("100%");
- paintedTimescaleBands.put(key, un);
+ this.paintedTimescaleBands.put(key, un);
}
// else {
// TODO: log should come in next
@@ -139,14 +138,14 @@
}
/**
- * paints the visible segments (columns) on to the band This method mainly
- * sets up all the relevant mathematics, and passes down
+ * paints the visible segments (columns) on to the band This method mainly sets up all the relevant mathematics, and
+ * passes down
*/
private void paintVisibleScale() {
- final long visibleLeft = band.getMinVisibleDate();
- final long visibleRight = band.getMaxVisibleDate();
+ final long visibleLeft = this.band.getMinVisibleDate();
+ final long visibleRight = this.band.getMaxVisibleDate();
- final Unit unit = band.getUnit();
+ final Unit unit = this.band.getUnit();
// We do not want to generate all the time scale segments,
// the number of visible segments is number of time 'unit' is in the
@@ -155,7 +154,7 @@
// first visible segment is going to be located at
final long firstVisibleSegmentPixel = TimeConversionUtil.timeToPixel(visibleLeft
- - (visibleLeft % unit.getMilliseconds()), band);
+ - (visibleLeft % unit.getMilliseconds()), this.band);
// TODO: uncomment all the debug statements and change global logging
// level to info
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeband.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeband.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeband.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -2,6 +2,7 @@
import java.util.ArrayList;
import java.util.List;
+import java.util.Map;
import java.util.TreeMap;
import com.allen_sauer.gwt.log.client.Log;
@@ -20,10 +21,9 @@
import com.tyndalehouse.step.web.shared.timeline.Unit;
/**
- * The TimeBand object represents a section of the timeline that contains the
- * events. There are many timebands on the timeline. Timebands contain
- * TimeScales representing units as well as TapeTracks which contain the events
- * The events are logically held on the Timeband, but painted on the time track.
+ * The TimeBand object represents a section of the timeline that contains the events. There are many timebands on the
+ * timeline. Timebands contain TimeScales representing units as well as TapeTracks which contain the events The events
+ * are logically held on the Timeband, but painted on the time track.
*
* @author CJBurrell
*/
@@ -44,10 +44,9 @@
private long currentDateX = 0;
/**
- * when this is set to true, then we can use the request window object to
- * determine whether or not we are showing all the events we are able to If
- * events can be deleted or moved to other timebands, it becomes difficult
- * to work out what the request window should be.
+ * when this is set to true, then we can use the request window object to determine whether or not we are showing
+ * all the events we are able to If events can be deleted or moved to other timebands, it becomes difficult to work
+ * out what the request window should be.
*/
private boolean deletionsDisabled = true;
@@ -59,7 +58,7 @@
/**
* this contains all the events on the time band
*/
- private final TreeMap<Integer, TimeEvent> events;
+ private final Map<Integer, TimeEvent> events;
/**
* Id of the timeband
@@ -92,16 +91,14 @@
private int mouseDownScrollLeft;
/**
- * original unit as set up before it was rendered for the first time This is
- * used so that we can revert back to the original, recommended unit at
- * point in time
+ * original unit as set up before it was rendered for the first time This is used so that we can revert back to the
+ * original, recommended unit at point in time
*/
private Unit originalUnit = null;
// TODO:Derive this from a properties file? somehow? or database?
/**
- * this describes how much of a unit needs to be visible before calling back
- * to the server
+ * this describes how much of a unit needs to be visible before calling back to the server
*/
private double outstandingUnitFactor = TimelineConstants.MINIMUM_UNIT_PORTION_BEFORE_SERVER_CALL;
@@ -116,9 +113,8 @@
private int pixelsPerUnit;
/**
- * Each timeband is given a request window. This object is responsible of
- * working out how much to request from the server, so as not to flood it
- * with requests of stuff it already has
+ * Each timeband is given a request window. This object is responsible of working out how much to request from the
+ * server, so as not to flood it with requests of stuff it already has
*/
private TimebandRequestWindow requestWindow = null;
@@ -143,33 +139,27 @@
private Element timebandLabel;
/**
- * This is the timescale visible on the timeband drawing lines across the
- * timebands for each unit
+ * This is the timescale visible on the timeband drawing lines across the timebands for each unit
*/
private TimeScale timescale;
/**
- * Determines the unit of the timeband and how to convert from/to
- * time/pixels
+ * Determines the unit of the timeband and how to convert from/to time/pixels
*/
private Unit unit;
/**
- * This determines how much of a zoom is applied. For example a factor of
- * 0.25 changes the scale of 50 pixels per decade to (1 + 0.25) * 50 = 75
- * pixels
+ * This determines how much of a zoom is applied. For example a factor of 0.25 changes the scale of 50 pixels per
+ * decade to (1 + 0.25) * 50 = 75 pixels
*/
private double zoomFactor = TimelineConstants.ZOOM_FACTOR;
/**
* To create a new timeband on the timeline
*
- * @param parent
- * the timeline on which it is to be created
- * @param id
- * the id of the timeband
- * @param description
- * its description
+ * @param parent the timeline on which it is to be created
+ * @param id the id of the timeband
+ * @param description its description
*/
public Timeband(final Timeline parent, final int id, final String description) {
this.parent = parent;
@@ -177,29 +167,27 @@
this.description = description;
// set up collections
- events = new TreeMap<Integer, TimeEvent>();
- tapeTracks = new ArrayList<TapeTrack>();
+ this.events = new TreeMap<Integer, TimeEvent>();
+ this.tapeTracks = new ArrayList<TapeTrack>();
// set up page properties
- bandDiv = DOM.createDiv();
- timebandContainer = DOM.createDiv();
- bandDiv.setClassName("step-timeband");
- setElement(timebandContainer);
+ this.bandDiv = DOM.createDiv();
+ this.timebandContainer = DOM.createDiv();
+ this.bandDiv.setClassName("step-timeband");
+ setElement(this.timebandContainer);
}
/**
- * Adds an event to the timeband, and therefore on to a random timetack. The
- * first available spot to minimize the space required. In particular this
- * delegates to addEventToTapeTrack after checking the event is not already
- * in our list of events
+ * Adds an event to the timeband, and therefore on to a random timetack. The first available spot to minimize the
+ * space required. In particular this delegates to addEventToTapeTrack after checking the event is not already in
+ * our list of events
*
- * @param event
- * event to be added
+ * @param event event to be added
*/
public void addEvent(final TimeEvent event) {
// need to check the event isn't already in our list:
- if (!events.containsKey(event.getId())) {
- events.put(event.getId(), event);
+ if (!this.events.containsKey(event.getId())) {
+ this.events.put(event.getId(), event);
addEventToTapeTrack(event);
// TODO: analyse this, but it is likely that it is not possible
@@ -213,85 +201,77 @@
}
/**
- * This method is used to tell the Timeband that it now has all events
- * within the section: (x1,x2). We can then use this to ensure subsequent
- * requests don't request the same thing from the server, hence reducing
- * load between the server and the client and also reducing the load on the
- * server
+ * This method is used to tell the Timeband that it now has all events within the section: (x1,x2). We can then use
+ * this to ensure subsequent requests don't request the same thing from the server, hence reducing load between the
+ * server and the client and also reducing the load on the server
*
- * @param minDateRequested
- * the minimum date that was requested and retrieved from the
- * back-end
- * @param maxDateRequested
- * the maximum date that was requested and retrieved from the
- * back-end
+ * @param minDateRequested the minimum date that was requested and retrieved from the back-end
+ * @param maxDateRequested the maximum date that was requested and retrieved from the back-end
*/
public void adjustRequestedView(final long minDateRequested, final long maxDateRequested) {
- if (requestWindow == null) {
- requestWindow = new TimebandRequestWindow(minDateRequested, maxDateRequested);
+ if (this.requestWindow == null) {
+ this.requestWindow = new TimebandRequestWindow(minDateRequested, maxDateRequested);
} else {
- requestWindow.adjustRange(minDateRequested, maxDateRequested);
+ this.requestWindow.adjustRange(minDateRequested, maxDateRequested);
}
}
/**
- * when a mousedown event has been captured, update the position at which
- * the mouse was
+ * when a mousedown event has been captured, update the position at which the mouse was
*
- * @param e
- * the mousedown event
+ * @param e the mousedown event
*/
public void captureScrollLeft(final MouseDownEvent e) {
- this.mouseDownScrollLeft = timebandContainer.getScrollLeft();
+ this.mouseDownScrollLeft = this.timebandContainer.getScrollLeft();
}
/**
* @return the bandDiv
*/
public Element getBandDiv() {
- return bandDiv;
+ return this.bandDiv;
}
/**
* @return the currentDate
*/
public long getCurrentDate() {
- return currentDate;
+ return this.currentDate;
}
/**
* @return the currentDateX
*/
public long getCurrentDateX() {
- return currentDateX;
+ return this.currentDateX;
}
/**
* @return the description
*/
public String getDescription() {
- return description;
+ return this.description;
}
/**
* @return the events
*/
- public TreeMap<Integer, TimeEvent> getEvents() {
- return events;
+ public Map<Integer, TimeEvent> getEvents() {
+ return this.events;
}
/**
* @return the id
*/
public int getId() {
- return id;
+ return this.id;
}
/**
* @return the maxDate
*/
public long getMaxDate() {
- return maxDate;
+ return this.maxDate;
}
/**
@@ -300,7 +280,7 @@
* @return the maximum date visible on the band
*/
public long getMaxVisibleDate() {
- int realClientWidth = timebandContainer.getClientWidth();
+ int realClientWidth = this.timebandContainer.getClientWidth();
// if this is not rendered properly yet, then we have no width:
if (realClientWidth == 0) {
// use the timeline width, perhaps we can take the parent width
@@ -310,14 +290,14 @@
realClientWidth = Window.getClientWidth();
}
- return TimeConversionUtil.pixelToTime(timebandContainer.getScrollLeft() + realClientWidth, this);
+ return TimeConversionUtil.pixelToTime(this.timebandContainer.getScrollLeft() + realClientWidth, this);
}
/**
* @return the minDate, in pixels
*/
public long getMinDate() {
- return minDate;
+ return this.minDate;
}
/**
@@ -326,18 +306,18 @@
* @return the minimum date visible on the band
*/
public long getMinVisibleDate() {
- return TimeConversionUtil.pixelToTime(timebandContainer.getScrollLeft(), this);
+ return TimeConversionUtil.pixelToTime(this.timebandContainer.getScrollLeft(), this);
}
/**
- * Could this be optimized by organising the events in time order, and on
- * scroll recording which events have popped off?
+ * Could this be optimized by organising the events in time order, and on scroll recording which events have popped
+ * off?
*
* @return the number of visible events in the band
*/
public int getNumberOfVisibleEvents() {
int count = 0;
- for (final TimeEvent te : events.values()) {
+ for (final TimeEvent te : this.events.values()) {
if (isEventInVisibleSection(te)) {
count++;
}
@@ -346,29 +326,27 @@
}
/**
- * Works out how much of the timeband is to be requested Ideally we should
- * TODO: this somewhere else.
+ * Works out how much of the timeband is to be requested Ideally we should TODO: this somewhere else.
*
* @return the visible section of the timeband
- * @throws IncapableOfCalculatingRequestWindowException
- * thrown if we are not in a position to calculate what the
+ * @throws IncapableOfCalculatingRequestWindowException thrown if we are not in a position to calculate what the
* remaining section is.
*/
public TimeBandVisibleDate getOustandingTimebandPeriod() throws IncapableOfCalculatingRequestWindowException {
final long minVisibleDate = getMinVisibleDate();
final long maxVisibleDate = getMaxVisibleDate();
- final long minimumDifference = (long) (unit.getMilliseconds() * outstandingUnitFactor);
+ final long minimumDifference = (long) (this.unit.getMilliseconds() * this.outstandingUnitFactor);
// the new requested bit depends on our request window
- if (requestWindow == null) {
- return new TimeBandVisibleDate(id, minVisibleDate, maxVisibleDate);
+ if (this.requestWindow == null) {
+ return new TimeBandVisibleDate(this.id, minVisibleDate, maxVisibleDate);
} else {
// return only the portion that has changed (probably only one pixel
// worth)!
// -------|--------$------|-----$--------------------
// mvd mrd Mvd Mrd
- final long minReceivedDate = requestWindow.getMinDate();
- final long maxReceivedDate = requestWindow.getMaxDate();
+ final long minReceivedDate = this.requestWindow.getMinDate();
+ final long maxReceivedDate = this.requestWindow.getMaxDate();
final boolean shiftedLeft = minVisibleDate < minReceivedDate;
final boolean shiftedRight = maxVisibleDate > maxReceivedDate;
@@ -377,7 +355,7 @@
} else if (shiftedLeft && shiftedRight) {
// in this case, it was probably a zoom, and so we need to
// request both parts
- return new TimeBandVisibleDate(id, minVisibleDate, maxVisibleDate);
+ return new TimeBandVisibleDate(this.id, minVisibleDate, maxVisibleDate);
} else if (shiftedLeft) {
// window could potentially have jumped, so there may be a gap
// between maxVisibleDate and min, so take so check that first:
@@ -388,14 +366,14 @@
// as with units and zooming, we're going to have to
// eventually repaint huge amounts of stuff
// so reset to 0
- requestWindow = null;
+ this.requestWindow = null;
// TODO: investigate whether we want to clear the band down!
- return new TimeBandVisibleDate(id, minVisibleDate, maxVisibleDate);
+ return new TimeBandVisibleDate(this.id, minVisibleDate, maxVisibleDate);
} else {
// the max is greater than the minimum so we return
if (minReceivedDate - minVisibleDate > minimumDifference) {
- return new TimeBandVisibleDate(id, minVisibleDate, minReceivedDate);
+ return new TimeBandVisibleDate(this.id, minVisibleDate, minReceivedDate);
} else {
return TimeBandVisibleDate.getNoRequest();
}
@@ -403,13 +381,13 @@
} else if (shiftedRight) {
// same problem as above if
if (minVisibleDate > maxReceivedDate) {
- requestWindow = null;
- return new TimeBandVisibleDate(id, minVisibleDate, maxVisibleDate);
+ this.requestWindow = null;
+ return new TimeBandVisibleDate(this.id, minVisibleDate, maxVisibleDate);
} else {
// in particular check that the gap between maxReceivedDate
// and maxVisibleDate is enough
if (maxVisibleDate - maxReceivedDate > minimumDifference) {
- return new TimeBandVisibleDate(id, maxReceivedDate, maxVisibleDate);
+ return new TimeBandVisibleDate(this.id, maxReceivedDate, maxVisibleDate);
} else {
return TimeBandVisibleDate.getNoRequest();
}
@@ -425,51 +403,49 @@
* @return the outstandingUnitFactor
*/
public double getOutstandingUnitFactor() {
- return outstandingUnitFactor;
+ return this.outstandingUnitFactor;
}
/**
* @return the pixelsPerUnit
*/
public int getPixelsPerUnit() {
- return pixelsPerUnit;
+ return this.pixelsPerUnit;
}
/**
* returns a single event contained on the timeband
*
- * @param eventId
- * event id of the event
+ * @param eventId event id of the event
* @return the TimeEvent
*/
public TimeEvent getSingleEvent(final String eventId) {
final Integer key = Integer.parseInt(eventId);
- return events.get(key);
+ return this.events.get(key);
}
/**
- * current number of tape tracks on the band. Also remember that one tape
- * track is allocated at the top of the timeband to allow for dates to be
- * displayed
+ * current number of tape tracks on the band. Also remember that one tape track is allocated at the top of the
+ * timeband to allow for dates to be displayed
*
* @return the numbers of tracks on the band
*/
public int getSizeTapeTracks() {
- return tapeTracks.size();
+ return this.tapeTracks.size();
}
/**
* @return the unit
*/
public Unit getUnit() {
- return unit;
+ return this.unit;
}
/**
* @return the zoomFactor
*/
public double getZoomFactor() {
- return zoomFactor;
+ return this.zoomFactor;
}
/**
@@ -478,14 +454,14 @@
public void hideFromUser() {
// set height to 0 by default, and we'll add something later TODO: to
// see which bands have got events...
- new El(timebandContainer).setHeight(0);
+ new El(this.timebandContainer).setHeight(0);
}
/**
* @return the deletionsDisabled
*/
public boolean isDeletionsDisabled() {
- return deletionsDisabled;
+ return this.deletionsDisabled;
}
/**
@@ -494,36 +470,36 @@
* @return true if the band has been rendered
*/
public boolean isRendered() {
- return isRendered;
+ return this.isRendered;
}
/**
* @return the showScale
*/
public boolean isShowScale() {
- return showScale;
+ return this.showScale;
}
/**
* @return the isUserInterested
*/
public boolean isUserInterested() {
- return isUserInterested;
+ return this.isUserInterested;
}
/**
* Does not delete the events but redraws everything else.
*/
public void redrawBand() {
- tapeTracks.clear();
+ this.tapeTracks.clear();
// use El to remove all children
- new El(bandDiv).removeChildren();
+ new El(this.bandDiv).removeChildren();
resetAllEvents();
- timescale.repaint();
+ this.timescale.repaint();
- requestWindow = null;
+ this.requestWindow = null;
drawEvents();
}
@@ -532,15 +508,14 @@
* Resets the timeband and redraws it
*/
public void redrawEmptyBand() {
- events.clear();
+ this.events.clear();
redrawBand();
}
/**
* true if the band is targetted from user input
*
- * @param isUserInterested
- * identifies whether a user is interested in the band
+ * @param isUserInterested identifies whether a user is interested in the band
*/
public void registerUserInterest(final boolean isUserInterested) {
this.isUserInterested = isUserInterested;
@@ -549,18 +524,16 @@
/**
* Removes an event from the band
*
- * @param id
- * the id of the event to be removed.
- * @throws CannotDeleteEventException
- * An event cannot be removed from a timeband.
+ * @param id the id of the event to be removed.
+ * @throws CannotDeleteEventException An event cannot be removed from a timeband.
*/
public void removeEvent(final int id) throws CannotDeleteEventException {
- if (deletionsDisabled) {
+ if (this.deletionsDisabled) {
throw new CannotDeleteEventException("The event you are trying to delete (" + id + ") is on band set on"
+ "deletionsDisabled = true");
}
- events.remove(id);
+ this.events.remove(id);
// TODO: refresh the timeline dom
}
@@ -568,16 +541,16 @@
* resets the band to use the original unit
*/
public void resetOriginalUnit() {
- setUnit(originalUnit);
+ setUnit(this.originalUnit);
}
/**
* Resizes bands dependant on how many bands are present.
*/
public void resizeBand() {
- if (isUserInterested) {
+ if (this.isUserInterested) {
// resize the timeband to take account of the number of timetracks
- new El(timebandContainer).setHeight(tapeTracks.size() * TimelineConstants.TAPE_TRACK_HEIGHT);
+ new El(this.timebandContainer).setHeight(this.tapeTracks.size() * TimelineConstants.TAPE_TRACK_HEIGHT);
}
}
@@ -585,14 +558,14 @@
* Gets the band to scroll to the current date
*/
public void scrollToCurrentDate() {
- Log.debug("Client width /2 : " + (timebandContainer.getClientWidth() / 2));
- new El(timebandContainer).setScrollLeft((int) currentDateX - (timebandContainer.getClientWidth() / 2));
+ Log.debug("Client width /2 : " + (this.timebandContainer.getClientWidth() / 2));
+ new El(this.timebandContainer).setScrollLeft((int) this.currentDateX
+ - (this.timebandContainer.getClientWidth() / 2));
displayTimebandLabel();
}
/**
- * @param bandDiv
- * the bandDiv to set
+ * @param bandDiv the bandDiv to set
*/
public final void setBandDiv(final Element bandDiv) {
this.bandDiv = bandDiv;
@@ -601,8 +574,7 @@
/**
* resetting the current date...
*
- * @param currentDate
- * the date on which the timeband is rooted
+ * @param currentDate the date on which the timeband is rooted
*/
public void setCurrentDate(final long currentDate) {
this.currentDate = currentDate;
@@ -614,65 +586,57 @@
}
/**
- * @param currentDateX
- * the currentDateX to set
+ * @param currentDateX the currentDateX to set
*/
public void setCurrentDateX(final long currentDateX) {
this.currentDateX = currentDateX;
}
/**
- * @param deletionsDisabled
- * the deletionsDisabled to set
+ * @param deletionsDisabled the deletionsDisabled to set
*/
public void setDeletionsDisabled(final boolean deletionsDisabled) {
this.deletionsDisabled = deletionsDisabled;
}
/**
- * @param description
- * the description to set
+ * @param description the description to set
*/
public void setDescription(final String description) {
this.description = description;
}
/**
- * @param id
- * the id to set
+ * @param id the id to set
*/
public void setId(final int id) {
this.id = id;
}
/**
- * @param maxDate
- * the maxDate to set
+ * @param maxDate the maxDate to set
*/
public void setMaxDate(final long maxDate) {
this.maxDate = maxDate;
}
/**
- * @param minDate
- * the minDate to set
+ * @param minDate the minDate to set
*/
public void setMinDate(final long minDate) {
this.minDate = minDate;
}
/**
- * Usuall, the first call ever to set the unit of the timeband. The original
- * unit gets cached in the originalUnit field For other uses, use @see
- * {@link Timeband.setUnit} If not set, then it gets set. Otherwise a
- * warning if produced
+ * Usuall, the first call ever to set the unit of the timeband. The original unit gets cached in the originalUnit
+ * field For other uses, use @see {@link Timeband.setUnit} If not set, then it gets set. Otherwise a warning if
+ * produced
*
- * @param unit
- * unit to be associated with the timeband
+ * @param unit unit to be associated with the timeband
*/
public void setOriginalUnit(final Unit unit) {
- if (originalUnit == null) {
- originalUnit = unit;
+ if (this.originalUnit == null) {
+ this.originalUnit = unit;
} else {
Log.warn("Original unit is already set. Please use resetOriginalUnit instead");
}
@@ -680,16 +644,14 @@
}
/**
- * @param outstandingUnitFactor
- * the outstandingUnitFactor to set
+ * @param outstandingUnitFactor the outstandingUnitFactor to set
*/
public void setOutstandingUnitFactor(final double outstandingUnitFactor) {
this.outstandingUnitFactor = outstandingUnitFactor;
}
/**
- * @param pixelsPerUnit
- * the pixelsPerUnit to set
+ * @param pixelsPerUnit the pixelsPerUnit to set
*/
public void setPixelsPerUnit(final int pixelsPerUnit) {
this.pixelsPerUnit = pixelsPerUnit;
@@ -698,15 +660,10 @@
/**
* sets the new position of the window, when the user is moving it
*
- * @param previousClientX
- * the previousPosition on the x axis
- * @param newClientX
- * the new position where it should be moved
- * @param defaultUnit
- * the default unit which should be used to calculate the time
- * difference
- * @param defaultPixelsPerUnit
- * the default number of pixels per unit
+ * @param previousClientX the previousPosition on the x axis
+ * @param newClientX the new position where it should be moved
+ * @param defaultUnit the default unit which should be used to calculate the time difference
+ * @param defaultPixelsPerUnit the default number of pixels per unit
*/
public void setScrollLeft(final int previousClientX, final int newClientX, final Unit defaultUnit,
final int defaultPixelsPerUnit) {
@@ -714,38 +671,35 @@
// say default is 1 Year
// this one is 10 years
// unit Factor = 0.1 so we scroll 10 times less pixels
- final double unitFactor = (double) defaultUnit.getMilliseconds() / (double) unit.getMilliseconds();
+ final double unitFactor = (double) defaultUnit.getMilliseconds() / (double) this.unit.getMilliseconds();
// now say instead unit factor is 1, ie. the same unit, but different
// number of pixels
// default is 50 pixels per year, this one is 25 pixels a year
// so we want to scroll half
- final double pixelFactor = (double) pixelsPerUnit / (double) defaultPixelsPerUnit;
+ final double pixelFactor = (double) this.pixelsPerUnit / (double) defaultPixelsPerUnit;
final double xAxisDiff = (previousClientX - newClientX) * (unitFactor * pixelFactor);
- final int newScrollLeft = (int) (mouseDownScrollLeft + xAxisDiff);
+ final int newScrollLeft = (int) (this.mouseDownScrollLeft + xAxisDiff);
this.timebandContainer.setScrollLeft(newScrollLeft);
displayTimebandLabel();
}
/**
- * @param showScale
- * the showScale to set
+ * @param showScale the showScale to set
*/
public void setShowScale(final boolean showScale) {
this.showScale = showScale;
}
/**
- * @param unit
- * the unit to set
+ * @param unit the unit to set
*/
public void setUnit(final Unit unit) {
this.unit = unit;
}
/**
- * @param zoomFactor
- * the zoomFactor to set
+ * @param zoomFactor the zoomFactor to set
*/
public void setZoomFactor(final double zoomFactor) {
this.zoomFactor = zoomFactor;
@@ -755,44 +709,40 @@
* Zooms in
*/
public void zoomIn() {
- zoom(1 + zoomFactor);
+ zoom(1 + this.zoomFactor);
}
/**
- * The way zooming works is that we recalculate the positions of all events
- * on the timeline
+ * The way zooming works is that we recalculate the positions of all events on the timeline
*/
public void zoomOut() {
// first change the zoom factor, then repaint events, and the timescale
// lets just assume a default zoom factor for now
// TODO: zoom in factor to be parameterised
- zoom(1 - zoomFactor);
+ zoom(1 - this.zoomFactor);
}
/**
- * Adds an event to the tape track. This ensures that the event has not
- * already been rendered If so, then it is present somewhere, perhaps not on
- * this band though. Then, iterates through the tape tracks trying to add
- * the event (i.e. asking each track whether there is space for the icon and
- * the text to be added)
+ * Adds an event to the tape track. This ensures that the event has not already been rendered If so, then it is
+ * present somewhere, perhaps not on this band though. Then, iterates through the tape tracks trying to add the
+ * event (i.e. asking each track whether there is space for the icon and the text to be added)
*
- * @param event
- * event to be added to the tape track
+ * @param event event to be added to the tape track
*/
private void addEventToTapeTrack(final TimeEvent event) {
- int startIndex = showScale ? 1 : 0; // leaving room for the scale band
+ int startIndex = this.showScale ? 1 : 0; // leaving room for the scale band
// if event is added already, then exit
if (event.isRendered()) {
return;
}
- while (startIndex < tapeTracks.size()) {
+ while (startIndex < this.tapeTracks.size()) {
// Log.debug("Trying to add " + event.getDescription() +
// " to track " + startIndex);
// try and add event to track
- if (tapeTracks.get(startIndex).addEvent(event)) {
+ if (this.tapeTracks.get(startIndex).addEvent(event)) {
return;
}
startIndex++;
@@ -801,7 +751,7 @@
// Log.debug("Going to create a new tape track");
// check that the event was added, otherwise add timetrack
- if (startIndex >= tapeTracks.size()) {
+ if (startIndex >= this.tapeTracks.size()) {
// did not manage to add it to tracks. therefore, let's add another
// one:
final TapeTrack t = addNewTapeTrack();
@@ -813,32 +763,30 @@
* Adds the timeband label to the band
*/
private void addLabelToBand() {
- timebandLabel = DOM.createDiv();
- final El gxtTimebandLabel = new El(timebandLabel);
+ this.timebandLabel = DOM.createDiv();
+ final El gxtTimebandLabel = new El(this.timebandLabel);
gxtTimebandLabel.setStyleName("step-timeband-label", true);
gxtTimebandLabel.setLeft(getElement().getScrollLeft());
- timebandLabel.setInnerText(description + "(" + id + ")");
- timebandContainer.appendChild(timebandLabel);
+ this.timebandLabel.setInnerText(this.description + "(" + this.id + ")");
+ this.timebandContainer.appendChild(this.timebandLabel);
}
/**
- * adds a new tape track to the timeband. The TapeTrack gets rendered at the
- * same time
+ * adds a new tape track to the timeband. The TapeTrack gets rendered at the same time
*
* @return the TapeTrack that was added
*/
private TapeTrack addNewTapeTrack() {
final TapeTrack t = new TapeTrack();
- tapeTracks.add(t);
+ this.tapeTracks.add(t);
t.paint(this);
return t;
}
/**
- * TODO: The idea is to adjust depending on how many pixels constitutes a
- * unit so that we can easily zoom in and out and have the units repainted
- * properly
+ * TODO: The idea is to adjust depending on how many pixels constitutes a unit so that we can easily zoom in and out
+ * and have the units repainted properly
*/
private void adjustUnit() {
@@ -848,7 +796,7 @@
* Displays the timeband label on the timeband, with the description of it
*/
private void displayTimebandLabel() {
- new El(timebandLabel).setLeft(getElement().getScrollLeft());
+ new El(this.timebandLabel).setLeft(getElement().getScrollLeft());
}
/**
@@ -858,17 +806,15 @@
// get the events to paint themselves (they will decide whether or not
// to
// paint if they are already showing...
- for (final TimeEvent te : events.values()) {
+ for (final TimeEvent te : this.events.values()) {
addEventToTapeTrack(te);
}
}
/**
- * Tells the caller whether the event is in the visible section of the div
- * on the browser.
+ * Tells the caller whether the event is in the visible section of the div on the browser.
*
- * @param event
- * the event to be tested
+ * @param event the event to be tested
* @return true if the event is in the visible section
*/
private boolean isEventInVisibleSection(final TimeEvent event) {
@@ -901,7 +847,7 @@
* Resets the rendered status on all events
*/
private void resetAllEvents() {
- for (final TimeEvent te : events.values()) {
+ for (final TimeEvent te : this.events.values()) {
te.reset();
}
}
@@ -909,14 +855,13 @@
/**
* Zooms out given a ratio
*
- * @param zoomRatio
- * the given ratio to zoom in and out
+ * @param zoomRatio the given ratio to zoom in and out
*/
private void zoom(final double zoomRatio) {
// TODO: somehow start with those events in the window (although for
// zoomout, won't make a different
// first change the scale
- pixelsPerUnit *= zoomRatio;
+ this.pixelsPerUnit *= zoomRatio;
adjustUnit();
redrawBand();
}
@@ -925,16 +870,16 @@
* adds the band to the DOM
*/
protected void addBandToUI() {
- final El el = new El(timebandContainer);
- final El gxtBandDiv = new El(bandDiv);
+ final El el = new El(this.timebandContainer);
+ final El gxtBandDiv = new El(this.bandDiv);
// set display options, ie. auto hide
// if (autoHide && !hasVisibleEvents()) {
// el.setDisplayed(false);
// }
- parent.getTimelineContainer().appendChild(timebandContainer);
- timebandContainer.appendChild(bandDiv);
+ this.parent.getTimelineContainer().appendChild(this.timebandContainer);
+ this.timebandContainer.appendChild(this.bandDiv);
addLabelToBand();
el.setStyleName("step-timeband-container");
@@ -950,27 +895,27 @@
protected void paint() {
// Log.debug("Request to paint band id:" + getId() + " Current date: " +
// getCurrentDate() + " Desc:" + getDescription());
- if (!isRendered) {
+ if (!this.isRendered) {
addBandToUI();
- isRendered = true;
+ this.isRendered = true;
}
// show scale band?
- if (showScale) {
+ if (this.showScale) {
// check if default time track has been added and add if not
- if (tapeTracks.size() == 0) {
+ if (this.tapeTracks.size() == 0) {
addNewTapeTrack();
}
- if (timescale == null) {
- timescale = new TimeScale(this);
+ if (this.timescale == null) {
+ this.timescale = new TimeScale(this);
}
- timescale.paint();
+ this.timescale.paint();
}
drawEvents();
- if (isUserInterested) {
+ if (this.isUserInterested) {
// after adding events, call the resizing function.
// It decides whether or not the band needs resizing, so no overhead
resizeBand();
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeline.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeline.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/Timeline.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -26,17 +26,14 @@
import com.tyndalehouse.step.web.shared.timeline.Unit;
/**
- * FEATURE: Add uncertain times from database as dotted events/bands FEATURE:
- * Add red line down the middle as current Sync line that tells user where bands
- * are sunk FEATURE: Proper descriptions appearing in hover popups FEATURE: Add
- * support for timetagging, history links, so that user can copy and paste url
- * BUG: Fix obvious units that are wrong BUG: Timeline doesn't render properly
- * when stuff is cached
+ * FEATURE: Add uncertain times from database as dotted events/bands FEATURE: Add red line down the middle as current
+ * Sync line that tells user where bands are sunk FEATURE: Proper descriptions appearing in hover popups FEATURE: Add
+ * support for timetagging, history links, so that user can copy and paste url BUG: Fix obvious units that are wrong
+ * BUG: Timeline doesn't render properly when stuff is cached
*
*
- * div .step-timeline (step-grab step-letgo) | | - div .step-timeline-container
- * | | - div .step-timeband-container | | - div .step-timeband | | - div .
- * step-scale-band
+ * div .step-timeline (step-grab step-letgo) | | - div .step-timeline-container | | - div .step-timeband-container | | -
+ * div .step-timeband | | - div . step-scale-band
*
* @author CJBurrell
*
@@ -69,10 +66,9 @@
private int height;
/**
- * whether the timeline is displayed horizontally or vertically (vertically
- * is not currently supported)
+ * whether the timeline is displayed horizontally or vertically (vertically is not currently supported)
*/
- private boolean isHorizontal;
+ private boolean horizontal;
/**
* whether the timeline module has been rendered
@@ -85,8 +81,8 @@
private final List<Timeband> timebands;
/**
- * The container for the timeline module, a DOM element wrapping the whole
- * lot this is for styling and makes it easier
+ * The container for the timeline module, a DOM element wrapping the whole lot this is for styling and makes it
+ * easier
*/
private final Element timelineContainer;
@@ -103,22 +99,21 @@
/**
* Default constructor
*
- * @param eventBus
- * the event bus to fire events on
+ * @param eventBus the event bus to fire events on
*/
public Timeline(/* final EventBus eventBus */) {
// this.eventBus = eventBus;
- timebands = new ArrayList<Timeband>();
+ this.timebands = new ArrayList<Timeband>();
- timelineContainer = DOM.createDiv();
- timelineContainer.setClassName("step-timeline-container");
+ this.timelineContainer = DOM.createDiv();
+ this.timelineContainer.setClassName("step-timeline-container");
- timelineDiv = DOM.createDiv();
- timelineDiv.setClassName("step-timeline");
- setElement(timelineDiv);
+ this.timelineDiv = DOM.createDiv();
+ this.timelineDiv.setClassName("step-timeline");
+ setElement(this.timelineDiv);
// set up hover over
- descriptor = new TimeEventDescriptor(this);
+ this.descriptor = new TimeEventDescriptor(this);
paint();
// addEventHandlers(eventBus);
@@ -128,27 +123,24 @@
/**
* Adds a band to a timeline module
*
- * @param band
- * the timeband to be added
+ * @param band the timeband to be added
*/
public synchronized void addBand(final Timeband band) {
- timebands.add(band);
+ this.timebands.add(band);
band.paint();
}
/**
- * Both on load and on scroll we are doing an awful lot of looping to
- * repaint just in case TODO: change this perhaps with a stack of repainting
- * needed to ensure that we only repaint those timebands that think they
- * need repainting. for example, we don't need to be repainting the whole
- * band for one event etc.
+ * Both on load and on scroll we are doing an awful lot of looping to repaint just in case TODO: change this perhaps
+ * with a stack of repainting needed to ensure that we only repaint those timebands that think they need repainting.
+ * for example, we don't need to be repainting the whole band for one event etc.
*/
public void fireTimelineScrollEvent() {
final TimelineScrollEvent tse = new TimelineScrollEvent();
// calculate only those bits that need requesting! but at the same time
// we don't need to wait for the server to redraw timebands
- for (final Timeband tb : timebands) {
+ for (final Timeband tb : this.timebands) {
try {
tb.paint(); // the timeband is rendered, and there are no new
// events,
@@ -182,15 +174,13 @@
/**
* returns a band to the caller based on the band id
*
- * @param bandId
- * the band id of the band to be returned
+ * @param bandId the band id of the band to be returned
* @return the relevant timeband
- * @throws TimeBandNotFoundException
- * thrown if bandId is not part of this timeline module
+ * @throws TimeBandNotFoundException thrown if bandId is not part of this timeline module
*/
public Timeband getBand(final int bandId) throws TimeBandNotFoundException {
// do a linear search - we're not going to have lots of timebands
- for (final Timeband t : timebands) {
+ for (final Timeband t : this.timebands) {
if (t.getId() == bandId) {
return t;
}
@@ -205,17 +195,16 @@
* @return the number of bands on the timeline module
*/
public int getBandCount() {
- return timebands.size();
+ return this.timebands.size();
}
/**
- * returns the list of the timeband. This is rather dangerous, and probably
- * should be protected
+ * returns the list of the timeband. This is rather dangerous, and probably should be protected
*
* @return the list of timebands
*/
public List<Timeband> getBands() {
- return timebands;
+ return this.timebands;
}
/**
@@ -225,7 +214,7 @@
*/
public List<CurrentBandStats> getCurrentBandStats() {
final List<CurrentBandStats> stats = new ArrayList<CurrentBandStats>();
- for (final Timeband band : timebands) {
+ for (final Timeband band : this.timebands) {
final CurrentBandStats bandStats = new CurrentBandStats(band.getId(), band.getDescription(), band
.getEvents().size(), band.getNumberOfVisibleEvents(), band.isUserInterested());
@@ -239,70 +228,65 @@
* @return the height
*/
public int getHeight() {
- return height;
+ return this.height;
}
/**
* @return the timelineContainer
*/
public Element getTimelineContainer() {
- return timelineContainer;
+ return this.timelineContainer;
}
/**
* @return the width
*/
public int getWidth() {
- return width;
+ return this.width;
}
/**
- * handles the mouse event, by alerting all the various bands to capture the
- * position of the mouse on them
+ * handles the mouse event, by alerting all the various bands to capture the position of the mouse on them
*
- * @param e
- * mouse event
+ * @param e mouse event
*/
public void handle(final MouseDownEvent e) {
- downStatus = true;
- clientX = e.getClientX();
+ this.downStatus = true;
+ this.clientX = e.getClientX();
// capture scrollLeft on every timeband
- for (final Timeband tb : timebands) {
+ for (final Timeband tb : this.timebands) {
tb.captureScrollLeft(e);
}
// Log.debug("ClientX " + clientX);
// change cursor to hand grab
- new El(timelineDiv).setStyleName("step-grab", true);
+ new El(this.timelineDiv).setStyleName("step-grab", true);
// cursor: hand; /* ? */ TODO
}
/**
- * handles a move of the mouse, Ensures we know what timeband has been fired
- * then if the mouse is down, then tells timebands to move across else,
- * perhaps we're mouse hovering over something, and a popup needs to be
- * shown
+ * handles a move of the mouse, Ensures we know what timeband has been fired then if the mouse is down, then tells
+ * timebands to move across else, perhaps we're mouse hovering over something, and a popup needs to be shown
*
- * @param e
- * the mouse move event
+ * @param e the mouse move event
*/
public void handle(final MouseMoveEvent e) {
- if (timebands.size() != 0) {
+ if (this.timebands.size() != 0) {
Timeband firedBand;
try {
firedBand = getFiredBand(e);
} catch (final UnknownFiredElement e1) {
Log.warn("Unknown element was fired");
- firedBand = timebands.get(0);
+ firedBand = this.timebands.get(0);
}
final Unit unit = firedBand.getUnit();
final int pixelsPerUnit = firedBand.getPixelsPerUnit();
- if (downStatus) {
+ if (this.downStatus) {
// mouse is down so move the scroll bars on each timeband
// for each timeband, scroll a certain amount... This amount
// though
@@ -311,8 +295,8 @@
// to
// allow service layer to update
// the events shown if necessary on each timeband
- for (final Timeband tb : timebands) {
- tb.setScrollLeft(clientX, e.getClientX(), unit, pixelsPerUnit);
+ for (final Timeband tb : this.timebands) {
+ tb.setScrollLeft(this.clientX, e.getClientX(), unit, pixelsPerUnit);
// Log.debug("About to scroll: " + (clientX -
// e.getClientX()));
}
@@ -330,22 +314,18 @@
}
/**
- * Sets the down status to false, simulating a mouse up, recording whether
- * the mouse is up or down, to false
+ * Sets the down status to false, simulating a mouse up, recording whether the mouse is up or down, to false
*
- * @param event
- * mouse out event
+ * @param event mouse out event
*/
public void handle(final MouseOutEvent event) {
- downStatus = false;
+ this.downStatus = false;
}
/**
- * on mouse over event, we call handleMouseOverTimeEvent to work out which
- * TimeEvent fired the event if at all
+ * on mouse over event, we call handleMouseOverTimeEvent to work out which TimeEvent fired the event if at all
*
- * @param e
- * mouse over event
+ * @param e mouse over event
*/
public void handle(final MouseOverEvent e) {
handleMouseOverTimeEvent(e);
@@ -354,21 +334,18 @@
/**
* on mouse up, we set the down status to false, and update the mouse icon
*
- * @param e
- * mouse up event
+ * @param e mouse up event
*/
public void handle(final MouseUpEvent e) {
- downStatus = false;
- new El(timelineDiv).setStyleName("step-letgo", true);
+ this.downStatus = false;
+ new El(this.timelineDiv).setStyleName("step-letgo", true);
}
/**
- * handles the display or remove of the popup An awful lot of events are
- * going to fired and captured and discarded and one wonders if this is
- * really the best way to do it
+ * handles the display or remove of the popup An awful lot of events are going to fired and captured and discarded
+ * and one wonders if this is really the best way to do it
*
- * @param e
- * move over event
+ * @param e move over event
*/
public void handleMouseOverTimeEvent(final MouseEvent<?> e) {
final EventTarget et = e.getNativeEvent().getEventTarget();
@@ -376,7 +353,7 @@
// find out if moved over event:
// Log.debug("Scanning " + timebands.size() + " timebands");
- for (final Timeband band : timebands) {
+ for (final Timeband band : this.timebands) {
// Log.debug("Scanning " + band.getEvents().size());
for (final TimeEvent te : band.getEvents().values()) {
if (te.getEventDiv().isOrHasChild(targetElement)) {
@@ -396,38 +373,35 @@
* @return the isHorizontal
*/
public boolean isHorizontal() {
- return isHorizontal;
+ return this.horizontal;
}
/**
* call this when you want to force a repaint
*/
- public synchronized void paint() {
- if (!isRendered) {
- timelineDiv.appendChild(timelineContainer);
+ public final void paint() {
+ if (!this.isRendered) {
+ this.timelineDiv.appendChild(this.timelineContainer);
int relativeTop = 0;
- for (final Timeband tb : timebands) {
+ for (final Timeband tb : this.timebands) {
tb.paint();
relativeTop += tb.getSizeTapeTracks() * TimelineConstants.TAPE_TRACK_HEIGHT;
}
// the total relative at this stage is the total height of the
// timeline
- new El(timelineDiv).setHeight(relativeTop);
- isRendered = true;
+ new El(this.timelineDiv).setHeight(relativeTop);
+ this.isRendered = true;
}
}
/**
* Repaints a particular timeband
*
- * @param originDate
- * date at which to start
- * @param unit
- * unit to be used on the timeband
- * @param timebandId
- * the timeband id
+ * @param originDate date at which to start
+ * @param unit unit to be used on the timeband
+ * @param timebandId the timeband id
*/
public void repaint(final Long originDate, final Unit unit, final int timebandId) {
// remove all the timebands from the timeline widget
@@ -438,10 +412,10 @@
// TODO: set other timbands back to their original scales
- for (final Timeband band : timebands) {
+ for (final Timeband band : this.timebands) {
setUserInterestOnBand(band, timebandId, unit);
band.setCurrentDate(originDate);
- band.setCurrentDateX(TimelineConstants.TIMELINE_WIDTH + timelineDiv.getClientWidth() / 2);
+ band.setCurrentDateX(TimelineConstants.TIMELINE_WIDTH + this.timelineDiv.getClientWidth() / 2);
band.scrollToCurrentDate();
band.redrawEmptyBand();
}
@@ -450,24 +424,21 @@
}
/**
- * @param height
- * the height to set
+ * @param height the height to set
*/
public void setHeight(final int height) {
this.height = height;
}
/**
- * @param isHorizontal
- * the isHorizontal to set
+ * @param isHorizontal the isHorizontal to set
*/
public void setHorizontal(final boolean isHorizontal) {
- this.isHorizontal = isHorizontal;
+ this.horizontal = isHorizontal;
}
/**
- * @param width
- * the width to set
+ * @param width the width to set
*/
public void setWidth(final int width) {
this.width = width;
@@ -477,7 +448,7 @@
* Zooming is done on a band level, so delegate to timebands
*/
public void zoomIn() {
- for (final Timeband tb : timebands) {
+ for (final Timeband tb : this.timebands) {
tb.zoomIn();
}
}
@@ -486,7 +457,7 @@
* Zooming is done on a band level, so delegate to timebands
*/
public void zoomOut() {
- for (final Timeband tb : timebands) {
+ for (final Timeband tb : this.timebands) {
tb.zoomOut();
}
}
@@ -494,8 +465,7 @@
/**
* adds event handlers to capture mouse movements, clicks, etc
*
- * @param eventBus
- * event bus on which to register some handlers
+ * @param eventBus event bus on which to register some handlers
*/
// TODO: investigate pushing the handlers in to the handler!!!
private void addEventHandlers(/* final EventBus eventBus */) {
@@ -527,33 +497,28 @@
}
/**
- * Disables the user selection on the timeline widget, to ensure the user
- * gets a good experience
+ * Disables the user selection on the timeline widget, to ensure the user gets a good experience
*
- * @param e
- * the DOM element on which to perform these javascript
- * operations
+ * @param e the DOM element on which to perform these javascript operations
*/
private native void disableSelection(final Element e) /*-{
- e.ondrag = function() { return false; };
- e.onselectstart = function() { return false; };
- e.style.MozUserSelect = "none";
- }-*/;
+ e.ondrag = function() { return false; };
+ e.onselectstart = function() { return false; };
+ e.style.MozUserSelect = "none";
+ }-*/;
/**
* returns the fired timeband band, given a mouse move event
*
- * @param e
- * the mouse band
+ * @param e the mouse band
* @return the timeband that was fired
- * @throws UnknownFiredElement
- * thrown if we do not know which timeband was fired
+ * @throws UnknownFiredElement thrown if we do not know which timeband was fired
*/
private Timeband getFiredBand(final MouseMoveEvent e) throws UnknownFiredElement {
final EventTarget et = e.getNativeEvent().getEventTarget();
final Element targetElement = et.cast();
- for (final Timeband b : timebands) {
+ for (final Timeband b : this.timebands) {
if (b.getBandDiv().isOrHasChild(targetElement)) {
return b;
}
@@ -563,15 +528,11 @@
}
/**
- * if the band corresponds to the correct timeband id, then set unit,
- * otherwise revert back to the original state...
+ * if the band corresponds to the correct timeband id, then set unit, otherwise revert back to the original state...
*
- * @param band
- * band
- * @param timebandId
- * timebandId
- * @param unit
- * unit
+ * @param band band
+ * @param timebandId timebandId
+ * @param unit unit
*/
private void setUserInterestOnBand(final Timeband band, final int timebandId, final Unit unit) {
if (band.getId() == timebandId) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/Orientation.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/Orientation.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/Orientation.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,8 +1,8 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.components;
/**
- * This determines whether to render the timeband horizontally or vertically. At
- * the moment only HORIZONTAL is supported.
+ * This determines whether to render the timeband horizontally or vertically. At the moment only HORIZONTAL is
+ * supported.
*
* @author CJBurrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimebandRequestWindow.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimebandRequestWindow.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimebandRequestWindow.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,9 +1,8 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.components;
/**
- * This window identifies what is already displayed on the timeline Perhaps
- * later we send this back to the server, and let the server work out which bits
- * and pieces each timebands are interested in. So still send the full view
+ * This window identifies what is already displayed on the timeline Perhaps later we send this back to the server, and
+ * let the server work out which bits and pieces each timebands are interested in. So still send the full view
* coordinates, but send that as well.
*
* @author CJBurrell
@@ -19,12 +18,8 @@
/**
* timeband request window, when created takes the intial window (min, max)
*
- * @param initialMin
- * initial minimum, usually the left most visible pixel of the
- * timeband
- * @param initialMax
- * initial maximum, usually the right most visible pixel of the
- * timeband
+ * @param initialMin initial minimum, usually the left most visible pixel of the timeband
+ * @param initialMax initial maximum, usually the right most visible pixel of the timeband
*/
public TimebandRequestWindow(final long initialMin, final long initialMax) {
minDate = initialMin;
@@ -34,10 +29,8 @@
/**
* Enlarges the minimum window on the left hand-side
*
- * @param minDateRequested
- * the new minDate that the band has received
- * @param maxDateRequested
- * the new maxDate that the band has received
+ * @param minDateRequested the new minDate that the band has received
+ * @param maxDateRequested the new maxDate that the band has received
*/
public void adjustRange(final long minDateRequested, final long maxDateRequested) {
// Log.debug("Adjusting minimum of received/requested window");
@@ -71,16 +64,14 @@
}
/**
- * @param maxDate
- * the maxDate to set
+ * @param maxDate the maxDate to set
*/
public void setMaxDate(final long maxDate) {
this.maxDate = maxDate;
}
/**
- * @param minDate
- * the minDate to set
+ * @param minDate the minDate to set
*/
public void setMinDate(final long minDate) {
this.minDate = minDate;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimelineConstants.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimelineConstants.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/components/TimelineConstants.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -34,8 +34,7 @@
*/
public static final long INITIAL_DATE = -61183987174853L;
/**
- * this describes how much of a unit needs to be visible before calling back
- * to the server
+ * this describes how much of a unit needs to be visible before calling back to the server
*/
public static final double MINIMUM_UNIT_PORTION_BEFORE_SERVER_CALL = 0.5;
/**
@@ -71,9 +70,8 @@
public static final int TIMELINE_WIDTH = 32000;
/**
- * The initial zoom factor. This determines how much of a zoom is applied.
- * For example a factor of 0.25 changes the scale of 50 pixels per decade to
- * (1 + 0.25) * 50 = 75 pixels
+ * The initial zoom factor. This determines how much of a zoom is applied. For example a factor of 0.25 changes the
+ * scale of 50 pixels per decade to (1 + 0.25) * 50 = 75 pixels
*/
public static final double ZOOM_FACTOR = 0.25;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/events/TimelineMouseHandler.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/events/TimelineMouseHandler.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/events/TimelineMouseHandler.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -13,8 +13,8 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.Timeline;
/**
- * timeline mouse handler to re-delegate events to the timeline component this
- * is used mainly for the scrolling functionality on the timeline
+ * timeline mouse handler to re-delegate events to the timeline component this is used mainly for the scrolling
+ * functionality on the timeline
*
* @author CJBurrell
*
@@ -29,8 +29,7 @@
/**
* constructor takes the timeline component
*
- * @param timeline
- * the timeline component.
+ * @param timeline the timeline component.
*/
public TimelineMouseHandler(final Timeline timeline) {
this.timeline = timeline;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/CannotDeleteEventException.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/CannotDeleteEventException.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/CannotDeleteEventException.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,8 +1,7 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.exceptions;
/**
- * The request to delete an event has failed. The message should explain why
- * this has happened.
+ * The request to delete an event has failed. The message should explain why this has happened.
*
* @author CJBurrell
*
@@ -12,8 +11,7 @@
/**
* The default constructor with the explanatory message
*
- * @param message
- * The message for the exception
+ * @param message The message for the exception
*/
public CannotDeleteEventException(final String message) {
super(message);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/IncapableOfCalculatingRequestWindowException.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/IncapableOfCalculatingRequestWindowException.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/IncapableOfCalculatingRequestWindowException.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,11 +1,9 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.exceptions;
/**
- * The request window is the window of pixels (start/end) that gets send to the
- * server indicating the client wants to get events that are in that time
- * section There are certain situations where it is impossible to calculate how
- * the user has moved, for example when the browser moves so quickly that the
- * whole screen shifts 1 screen-wide of pixels
+ * The request window is the window of pixels (start/end) that gets send to the server indicating the client wants to
+ * get events that are in that time section There are certain situations where it is impossible to calculate how the
+ * user has moved, for example when the browser moves so quickly that the whole screen shifts 1 screen-wide of pixels
*
* @author CJBurrell
*/
@@ -19,14 +17,10 @@
/**
* The client is unable to calculate which bit to request from the server
*
- * @param minVisibleDate
- * the minimum visible date from the client
- * @param maxVisibleDate
- * the maximum visible date from the client
- * @param minReceivedDate
- * the minimum date the client has ever seen
- * @param maxReceivedDate
- * the maximum date the client has ever seen
+ * @param minVisibleDate the minimum visible date from the client
+ * @param maxVisibleDate the maximum visible date from the client
+ * @param minReceivedDate the minimum date the client has ever seen
+ * @param maxReceivedDate the maximum date the client has ever seen
*/
public IncapableOfCalculatingRequestWindowException(final long minVisibleDate, final long maxVisibleDate,
final long minReceivedDate, final long maxReceivedDate) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/TimeBandNotFoundException.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/TimeBandNotFoundException.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/TimeBandNotFoundException.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -16,8 +16,7 @@
/**
* Constructor specifying the error message
*
- * @param message
- * message indicating which band was not found
+ * @param message message indicating which band was not found
*/
public TimeBandNotFoundException(final String message) {
super(message);
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/UnknownFiredElement.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/UnknownFiredElement.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/exceptions/UnknownFiredElement.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,8 +1,7 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.exceptions;
/**
- * Thrown if an DOM element contained in the timeline is fired but it is not
- * recognised by the timeline element
+ * Thrown if an DOM element contained in the timeline is fired but it is not recognised by the timeline element
*
* @author CJBurrell
*
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/CurrentBandStats.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/CurrentBandStats.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/CurrentBandStats.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -1,8 +1,7 @@
package com.tyndalehouse.step.web.client.toolkit.timeline.helpers;
/**
- * Contains the current statistics of how many events are present on a
- * particular timeband This bean is band specific
+ * Contains the current statistics of how many events are present on a particular timeband This bean is band specific
*
* @author CJBurrell
*
@@ -35,16 +34,11 @@
/**
*
- * @param bandId
- * the id of the band
- * @param numElements
- * the number of events on the band
- * @param numVisibleElements
- * the number of visible events in the frame
- * @param bandDescription
- * description to be displayed on the view
- * @param isUserInterested
- * whether the user is interested in the band
+ * @param bandId the id of the band
+ * @param numElements the number of events on the band
+ * @param numVisibleElements the number of visible events in the frame
+ * @param bandDescription description to be displayed on the view
+ * @param isUserInterested whether the user is interested in the band
*/
public CurrentBandStats(final int bandId, final String bandDescription, final int numElements,
final int numVisibleElements, final boolean isUserInterested) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/TimeConversionUtil.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/TimeConversionUtil.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/timeline/helpers/TimeConversionUtil.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -14,14 +14,10 @@
*/
public final class TimeConversionUtil {
/**
- * converts a pixel position to its date using the format associated to the
- * unit of the timeband
+ * converts a pixel position to its date using the format associated to the unit of the timeband
*
- * @param pixelPosition
- * pixel position to be converted
- * @param timeband
- * current timeband (this contains the current viewing location,
- * and unit
+ * @param pixelPosition pixel position to be converted
+ * @param timeband current timeband (this contains the current viewing location, and unit
* @return the date as a formatted string
*/
public static String formatPixelToTime(final long pixelPosition, final Timeband timeband) {
@@ -31,10 +27,8 @@
/**
* formats the given time using the unit described in the timeband
*
- * @param timeband
- * the timeband containing the current view, unit, etc.
- * @param eventDate
- * date to be formatted
+ * @param timeband the timeband containing the current view, unit, etc.
+ * @param eventDate date to be formatted
* @return the string representation of the date
*/
public static String formatTime(final long eventDate, final Timeband timeband) {
@@ -47,11 +41,9 @@
/**
* This takes a pixel position and returns the equivalent time
*
- * @param pixelPosition
- * the pixel position that we are trying to convert
- * @param timeband
- * the timeband which contains the relevant information (current
- * view, unit) to calculate the time from the pixel position
+ * @param pixelPosition the pixel position that we are trying to convert
+ * @param timeband the timeband which contains the relevant information (current view, unit) to calculate the time
+ * from the pixel position
* @return the time of pixelPosition
*/
public static long pixelToTime(final long pixelPosition, final Timeband timeband) {
@@ -68,10 +60,8 @@
/**
* A date is always calculated within a time band.
*
- * @param eventDate
- * the date to be converted
- * @param currentTimeband
- * reference timeband (including current view, unit, etc).
+ * @param eventDate the date to be converted
+ * @param currentTimeband reference timeband (including current view, unit, etc).
* @return the pixel position on the timeband for the passed in time
*/
public static int timeToPixel(final long eventDate, final Timeband currentTimeband) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/BibleVersionsDropDownComposite.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/BibleVersionsDropDownComposite.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/BibleVersionsDropDownComposite.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -33,7 +33,7 @@
// since memory footprint
public class BibleVersionsDropDownComposite extends Composite {
private static final String INITIAL_TEXT = "Please enter a bible version name";
- protected FlowPanel bibleVersionPanel = new FlowPanel();
+ private final FlowPanel bibleVersionPanel = new FlowPanel();
private final TextBox filterBox = new TextBox();
private final Tree bibleVersions = new Tree();
private final PopupPanel popup = new PopupPanel();
@@ -41,13 +41,13 @@
public BibleVersionsDropDownComposite() {
final ScrollPanel versionScroll = new ScrollPanel();
versionScroll.setHeight("85%");
- versionScroll.add(bibleVersions);
- bibleVersionPanel.add(filterBox);
+ versionScroll.add(this.bibleVersions);
+ this.bibleVersionPanel.add(this.filterBox);
- popup.add(versionScroll);
- popup.setAutoHideEnabled(true);
- popup.addAutoHidePartner(bibleVersions.getElement());
- popup.setStylePrimaryName("popupBibleVersions");
+ this.popup.add(versionScroll);
+ this.popup.setAutoHideEnabled(true);
+ this.popup.addAutoHidePartner(this.bibleVersions.getElement());
+ this.popup.setStylePrimaryName("popupBibleVersions");
// bibleVersionPanel.add(versionScroll);
@@ -56,16 +56,16 @@
addStyles();
setSuggestionsVisible(false);
- filterBox.setText(INITIAL_TEXT);
- initWidget(bibleVersionPanel);
+ this.filterBox.setText(INITIAL_TEXT);
+ initWidget(this.bibleVersionPanel);
}
/**
* adds styles to the components
*/
private void addStyles() {
- filterBox.addStyleName("prompt");
- bibleVersionPanel.addStyleName("bibleVersionsDropDown");
+ this.filterBox.addStyleName("prompt");
+ this.bibleVersionPanel.addStyleName("bibleVersionsDropDown");
}
private final KeyUpHandler typingFilterHandler = new KeyUpHandler() {
@@ -84,14 +84,14 @@
private void selectVersionIfAvailable() {
final String selectedVersion = this.filterBox.getText();
- final Iterator<TreeItem> treeIterator = bibleVersions.treeItemIterator();
+ final Iterator<TreeItem> treeIterator = this.bibleVersions.treeItemIterator();
while (treeIterator.hasNext()) {
final TreeItem nextItem = treeIterator.next();
final Object userObject = nextItem.getUserObject();
if (userObject instanceof Version) {
final Version v = (Version) userObject;
if (v.getInitials().equalsIgnoreCase(selectedVersion) || v.getName().equalsIgnoreCase(selectedVersion)) {
- bibleVersions.setSelectedItem(nextItem);
+ this.bibleVersions.setSelectedItem(nextItem);
return;
}
}
@@ -102,13 +102,13 @@
* adds the default handlers for the filter box
*/
private void addHandlersForFilterBox() {
- filterBox.addKeyUpHandler(typingFilterHandler);
+ this.filterBox.addKeyUpHandler(this.typingFilterHandler);
- filterBox.addFocusHandler(new FocusHandler() {
+ this.filterBox.addFocusHandler(new FocusHandler() {
public void onFocus(final FocusEvent focusEvent) {
- if (filterBox.getStyleName().contains("prompt")) {
- filterBox.setText("");
- filterBox.removeStyleName("prompt");
+ if (BibleVersionsDropDownComposite.this.filterBox.getStyleName().contains("prompt")) {
+ BibleVersionsDropDownComposite.this.filterBox.setText("");
+ BibleVersionsDropDownComposite.this.filterBox.removeStyleName("prompt");
}
// show the tree
@@ -117,12 +117,12 @@
});
// TODO: make textbox into widget
- filterBox.addBlurHandler(new BlurHandler() {
+ this.filterBox.addBlurHandler(new BlurHandler() {
public void onBlur(final BlurEvent event) {
- if (filterBox.getText().length() == 0) {
- filterBox.setText(INITIAL_TEXT);
- if (!filterBox.getStyleName().contains("prompt")) {
- filterBox.addStyleName("prompt");
+ if (BibleVersionsDropDownComposite.this.filterBox.getText().length() == 0) {
+ BibleVersionsDropDownComposite.this.filterBox.setText(INITIAL_TEXT);
+ if (!BibleVersionsDropDownComposite.this.filterBox.getStyleName().contains("prompt")) {
+ BibleVersionsDropDownComposite.this.filterBox.addStyleName("prompt");
}
}
}
@@ -132,21 +132,24 @@
/**
* sets whether the suggestions should be visible
*
- * @param visible
- * true to show the suggestions from the tree
+ * @param visible true to show the suggestions from the tree
*/
private void setSuggestionsVisible(final boolean visible) {
if (visible) {
- popup.setPopupPositionAndShow(new PositionCallback() {
+ this.popup.setPopupPositionAndShow(new PositionCallback() {
public void setPosition(final int offsetWidth, final int offsetHeight) {
- popup.setPopupPosition(filterBox.getAbsoluteLeft(), filterBox.getAbsoluteTop()
- + filterBox.getOffsetHeight());
- popup.setWidth(filterBox.getOffsetWidth() + "px");
+ BibleVersionsDropDownComposite.this.popup.setPopupPosition(
+ BibleVersionsDropDownComposite.this.filterBox.getAbsoluteLeft(),
+ BibleVersionsDropDownComposite.this.filterBox.getAbsoluteTop()
+ + BibleVersionsDropDownComposite.this.filterBox.getOffsetHeight());
+ BibleVersionsDropDownComposite.this.popup.setWidth(BibleVersionsDropDownComposite.this.filterBox
+ .getOffsetWidth()
+ + "px");
}
});
} else {
- popup.hide();
+ this.popup.hide();
}
// bibleVersions.addStyleName(visible ? "visible" : "invisible");
@@ -157,19 +160,20 @@
* adds handlers for tree
*/
private void addHandlersForTree() {
- bibleVersions.addKeyUpHandler(typingFilterHandler);
- bibleVersions.addSelectionHandler(new SelectionHandler<TreeItem>() {
+ this.bibleVersions.addKeyUpHandler(this.typingFilterHandler);
+ this.bibleVersions.addSelectionHandler(new SelectionHandler<TreeItem>() {
public void onSelection(final SelectionEvent<TreeItem> selectionEvent) {
if (selectionEvent.getSelectedItem().getChildCount() == 0) {
// on selection we close the tree and set the selected
// version
- filterBox.setText(bibleVersions.getSelectedItem().getText());
+ BibleVersionsDropDownComposite.this.filterBox
+ .setText(BibleVersionsDropDownComposite.this.bibleVersions.getSelectedItem().getText());
setSuggestionsVisible(false);
}
}
});
- bibleVersions.addFocusHandler(new FocusHandler() {
+ this.bibleVersions.addFocusHandler(new FocusHandler() {
public void onFocus(final FocusEvent arg0) {
setSuggestionsVisible(true);
}
@@ -180,8 +184,8 @@
* filters through the tree
*/
protected void refilterTree() {
- for (int ii = 0; ii < bibleVersions.getItemCount(); ii++) {
- filterTreeItem(bibleVersions.getItem(ii), filterBox.getText().toLowerCase());
+ for (int ii = 0; ii < this.bibleVersions.getItemCount(); ii++) {
+ filterTreeItem(this.bibleVersions.getItem(ii), this.filterBox.getText().toLowerCase());
}
hideEmptyParents();
@@ -191,8 +195,8 @@
* Hide parents where there are no children
*/
private void hideEmptyParents() {
- for (int ii = 0; ii < bibleVersions.getItemCount(); ii++) {
- final TreeItem parentLevelItem = bibleVersions.getItem(ii);
+ for (int ii = 0; ii < this.bibleVersions.getItemCount(); ii++) {
+ final TreeItem parentLevelItem = this.bibleVersions.getItem(ii);
// we ignore first level elements, only hide ones below for now
for (int jj = 0; jj < parentLevelItem.getChildCount(); jj++) {
@@ -209,8 +213,7 @@
/**
* returns the number of visible children
*
- * @param node
- * to be evaluated for number of visible children
+ * @param node to be evaluated for number of visible children
* @return
*/
private boolean hasVisibleChildren(final TreeItem node) {
@@ -230,10 +233,8 @@
/**
* filters tree items and their children
*
- * @param item
- * item to be filtered
- * @param text
- * the text currently in the box
+ * @param item item to be filtered
+ * @param text the text currently in the box
*/
private void filterTreeItem(final TreeItem item, final String text) {
// check for leaf node
@@ -263,8 +264,8 @@
public void addVersion(final String area, final String language, final String versionInitials,
final String versionName) {
// look for area first
- for (int ii = 0; ii < bibleVersions.getItemCount(); ii++) {
- final TreeItem item = bibleVersions.getItem(ii);
+ for (int ii = 0; ii < this.bibleVersions.getItemCount(); ii++) {
+ final TreeItem item = this.bibleVersions.getItem(ii);
if (item.getText().equals(area)) {
// now get the language
createLanguageVersionTreeSection(language, versionInitials, versionName, item);
@@ -276,7 +277,7 @@
final Area areaParent = new Area(area);
final TreeItem areaItem = new TreeItem(area);
areaItem.setUserObject(areaParent);
- bibleVersions.addItem(areaItem);
+ this.bibleVersions.addItem(areaItem);
createLanguageVersionTreeSection(language, versionInitials, versionName, areaItem);
}
@@ -284,14 +285,10 @@
/**
* creates the language and version node in the tree
*
- * @param language
- * language to be added to the tree
- * @param versionInitials
- * initials of the bible versions
- * @param versionName
- * version name as in jsword
- * @param item
- * parent item
+ * @param language language to be added to the tree
+ * @param versionInitials initials of the bible versions
+ * @param versionName version name as in jsword
+ * @param item parent item
*/
private void createLanguageVersionTreeSection(final String language, final String versionInitials,
final String versionName, final TreeItem item) {
@@ -318,12 +315,12 @@
// TODO can this be tested?
public HasSelectionHandlers<TreeItem> getVersionSelectorHandler() {
- return bibleVersions;
+ return this.bibleVersions;
// return filterBox;
}
public String getCurrentlySelectedVersion() {
- final TreeItem selectedItem = bibleVersions.getSelectedItem();
+ final TreeItem selectedItem = this.bibleVersions.getSelectedItem();
if (!(selectedItem == null)) {
final Area area = (Area) selectedItem.getUserObject();
if (area != null && area instanceof Version) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/OptionsButtonComposite.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/OptionsButtonComposite.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/OptionsButtonComposite.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -28,8 +28,8 @@
import com.tyndalehouse.step.web.shared.common.ScriptureDisplayOptions;
public class OptionsButtonComposite extends Composite implements HasOptionsHandler {
- final private InlinePanel holder = new InlinePanel();
- final private PopupPanel menu = new PopupPanel(false);
+ private final InlinePanel holder = new InlinePanel();
+ private final PopupPanel menu = new PopupPanel(false);
private final Image image;
private final HandlerManager handlerManager = new HandlerManager(this);
private final Map<String, ScriptureDisplayOptions> selectedOptions = new HashMap<String, ScriptureDisplayOptions>();
@@ -45,15 +45,16 @@
final String key = option.getName();
final ScriptureDisplayOptions scriptureDisplayOption = ScriptureDisplayOptions.getByKeyName(key);
if (checked.booleanValue()) {
- selectedOptions.put(key, scriptureDisplayOption);
+ OptionsButtonComposite.this.selectedOptions.put(key, scriptureDisplayOption);
} else {
- selectedOptions.remove(key);
+ OptionsButtonComposite.this.selectedOptions.remove(key);
}
// IMPROVEMENT we assume for now that a tick in the box always adds
// information to the screen
- handlerManager.fireEvent(new OptionEvent(scriptureDisplayOption, checked.booleanValue()));
- menu.hide();
+ OptionsButtonComposite.this.handlerManager.fireEvent(new OptionEvent(scriptureDisplayOption, checked
+ .booleanValue()));
+ OptionsButtonComposite.this.menu.hide();
}
};
@@ -61,43 +62,48 @@
* creates an options button
*/
public OptionsButtonComposite() {
- holder.addStyleName(RESOURCES.layout().floatRight());
- image = new Image(RESOURCES.options());
- holder.add(image);
- holder.addStyleName("optionsButton");
+ this.holder.addStyleName(RESOURCES.layout().floatRight());
+ this.image = new Image(RESOURCES.options());
+ this.holder.add(this.image);
+ this.holder.addStyleName("optionsButton");
initImageHandlers();
- initWidget(holder);
+ initWidget(this.holder);
}
private void initImageHandlers() {
- image.addClickHandler(new ClickHandler() {
+ this.image.addClickHandler(new ClickHandler() {
public void onClick(final ClickEvent clickEvent) {
switchVisibility();
}
});
- image.addMouseOutHandler(new MouseOutHandler() {
+ this.image.addMouseOutHandler(new MouseOutHandler() {
public void onMouseOut(final MouseOutEvent arg0) {
- image.setResource(RESOURCES.options());
+ OptionsButtonComposite.this.image.setResource(RESOURCES.options());
}
});
- image.addMouseOverHandler(new MouseOverHandler() {
+ this.image.addMouseOverHandler(new MouseOverHandler() {
public void onMouseOver(final MouseOverEvent arg0) {
- image.setResource(RESOURCES.optionsOver());
+ OptionsButtonComposite.this.image.setResource(RESOURCES.optionsOver());
}
});
}
private void switchVisibility() {
- if (menu.isShowing()) {
- menu.hide();
+ if (this.menu.isShowing()) {
+ this.menu.hide();
} else {
- menu.setPopupPositionAndShow(new PositionCallback() {
+ this.menu.setPopupPositionAndShow(new PositionCallback() {
public void setPosition(final int arg0, final int arg1) {
- menu.setPopupPosition(image.getAbsoluteLeft() + image.getOffsetWidth() / 2 - menu.getOffsetWidth(),
- image.getAbsoluteTop() + image.getOffsetHeight() / 2);
+ OptionsButtonComposite.this.menu.setPopupPosition(OptionsButtonComposite.this.image
+ .getAbsoluteLeft()
+ + OptionsButtonComposite.this.image.getOffsetWidth()
+ / 2
+ - OptionsButtonComposite.this.menu.getOffsetWidth(), OptionsButtonComposite.this.image
+ .getAbsoluteTop()
+ + OptionsButtonComposite.this.image.getOffsetHeight() / 2);
}
});
}
@@ -107,8 +113,8 @@
// TODO: look to see if we can something with GWT Inject/Gin to inject
// menus in...
final VerticalPanel vp = new VerticalPanel();
- menu.add(vp);
- menu.setGlassEnabled(false);
+ this.menu.add(vp);
+ this.menu.setGlassEnabled(false);
final ScriptureDisplayOptions[] scriptureDisplayOptions = ScriptureDisplayOptions.getScriptureDisplayOptions();
for (final ScriptureDisplayOptions option : scriptureDisplayOptions) {
@@ -127,14 +133,14 @@
}
if (option.isDefaultOption()) {
- selectedOptions.put(option.getKey(), option);
+ this.selectedOptions.put(option.getKey(), option);
}
vp.add(menuItem);
- menuItem.addValueChangeHandler(valueChangeHandler);
+ menuItem.addValueChangeHandler(this.valueChangeHandler);
}
- menu.hide();
- menu.addStyleName("optionsButtonMenu");
+ this.menu.hide();
+ this.menu.addStyleName("optionsButtonMenu");
}
@Override
@@ -148,6 +154,6 @@
}
public Map<String, ScriptureDisplayOptions> getSelectedOptions() {
- return selectedOptions;
+ return this.selectedOptions;
}
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/VerseLabel.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/VerseLabel.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/toolkit/widgets/VerseLabel.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -10,9 +10,8 @@
import com.google.gwt.user.client.ui.Label;
/**
- * Composite wrapper around a portion of scriptural text. The wrapper contains
- * data retrieved from the server such as lemmas (Strong numbers), morphological
- * data and an alternative word in the case of an interlinear
+ * Composite wrapper around a portion of scriptural text. The wrapper contains data retrieved from the server such as
+ * lemmas (Strong numbers), morphological data and an alternative word in the case of an interlinear
*
* @author cjburrell TODO remove
*
@@ -20,14 +19,12 @@
@Deprecated
public class VerseLabel extends Composite {
/**
- * if there is an interlinear, then this is where the alternative word is
- * stored
+ * if there is an interlinear, then this is where the alternative word is stored
*/
private Label alternativeWord;
/**
- * TODO: this should be removed into the presenter the event bus to fire off
- * events
+ * TODO: this should be removed into the presenter the event bus to fire off events
*/
// private final EventBus eventBus;
@@ -52,13 +49,10 @@
private List<String> morphs;
/**
- * This constructors initialises an instance of the composite wrapper and
- * sets up the panel, css, etc.
+ * This constructors initialises an instance of the composite wrapper and sets up the panel, css, etc.
*
- * @param text
- * the text to be wrapped
- * @param eventBus
- * the event bus if events are to be fired
+ * @param text the text to be wrapped
+ * @param eventBus the event bus if events are to be fired
*/
public VerseLabel(final String text /* TODO , final EventBus eventBus */) {
fp = new FlowPanel();
@@ -89,12 +83,10 @@
}
/**
- * sets the alternative word. This could be a Hebrew word, but for a classic
- * interlinear it could also be a English word, where the main word is the
- * Hebrew
+ * sets the alternative word. This could be a Hebrew word, but for a classic interlinear it could also be a English
+ * word, where the main word is the Hebrew
*
- * @param originalWord
- * an original word (for e.g. a hebrew translation)
+ * @param originalWord an original word (for e.g. a hebrew translation)
*/
public void setAlternativeWord(final String originalWord) {
if (alternativeWord != null) {
@@ -107,8 +99,7 @@
}
/**
- * @param lemma
- * the lemma to set
+ * @param lemma the lemma to set
*/
public void setLemmas(final List<String> lemma) {
this.lemmas = lemma;
@@ -126,8 +117,7 @@
}
/**
- * @param morph
- * the morph to set
+ * @param morph the morph to set
*/
public void setMorphs(final List<String> morph) {
this.morphs = morph;
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/BookmarkView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/BookmarkView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/BookmarkView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -58,8 +58,7 @@
}
/**
- * is the current bookmarks has reached capacity, then we remove the element
- * that is first in line to be removed.
+ * is the current bookmarks has reached capacity, then we remove the element that is first in line to be removed.
*/
private HasClickHandlers addHyperlink(final String shortNameReference, final FlowPanel fp,
final String layoutStyle, final String suffix) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/PassageView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/PassageView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/PassageView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -22,10 +22,9 @@
import com.tyndalehouse.step.web.shared.common.ScriptureDisplayOptions;
/**
- * This view is responsible for rendered a biblical/osis passage on to the web
- * page It creates elements such as words, titles, etc. For words, it returns
- * handlers for the user to be able to click on them. This is for words
- * containing lemmas only.
+ * This view is responsible for rendered a biblical/osis passage on to the web page It creates elements such as words,
+ * titles, etc. For words, it returns handlers for the user to be able to click on them. This is for words containing
+ * lemmas only.
*
* @author CJBurrell
*
@@ -39,29 +38,27 @@
private int numLines = 1;
public PassageView() {
- initWidget(passageHolder);
- passageHolder.add(optionsButtonWidget);
- passageHolder.add(passageTitle);
- passageHolder.add(mainPassage);
+ initWidget(this.passageHolder);
+ this.passageHolder.add(this.optionsButtonWidget);
+ this.passageHolder.add(this.passageTitle);
+ this.passageHolder.add(this.mainPassage);
setStyles();
}
private void setStyles() {
- passageTitle.addStyleName("passageTitle");
+ this.passageTitle.addStyleName("passageTitle");
}
/**
- * adds an option handler to the round button containing various display
- * options
+ * adds an option handler to the round button containing various display options
*
- * @param handler
- * the handler to execute
+ * @param handler the handler to execute
* @return the registration, in case the caller wants to unregister itself
*/
public HandlerRegistration addOptionHandler(final OptionHandler handler) {
- return optionsButtonWidget.addOptionHandler(handler);
+ return this.optionsButtonWidget.addOptionHandler(handler);
}
/**
@@ -70,7 +67,7 @@
* @return a map of all selected options
*/
public Map<String, ScriptureDisplayOptions> getSelectedOptions() {
- return optionsButtonWidget.getSelectedOptions();
+ return this.optionsButtonWidget.getSelectedOptions();
}
/**
@@ -83,8 +80,7 @@
/**
* displays a quote
*
- * @param text
- * the text to be displayed
+ * @param text the text to be displayed
*/
public void createQuote(final String text) {
this.createLabel(text, RESOURCES.passage().quote(), new InlineLabel());
@@ -93,8 +89,7 @@
/**
* Displays standard text/words
*
- * @param text
- * the text to be displayed
+ * @param text the text to be displayed
*/
public HasClickAndHighlightHandlers createText(final String text) {
final HighlightableLabel label = new HighlightableLabel();
@@ -122,8 +117,7 @@
/**
* concatenates strings together
*
- * @param morphs
- * a list of elements to be concatenated
+ * @param morphs a list of elements to be concatenated
* @return
*/
private String concatenate(final String[] attributes) {
@@ -138,8 +132,7 @@
/**
* displays a title
*
- * @param text
- * the text to be displayed
+ * @param text the text to be displayed
*/
public void createTitle(final String text) {
final Label title = new Label(text);
@@ -148,18 +141,17 @@
// TODO is this a hack? not sure how to get the first line of the
// passage to start below the icon
// reassess once we move the dropdowns into the passage widget
- if (numLines > 1) {
+ if (this.numLines > 1) {
title.addStyleName(RESOURCES.passage().interlinearTitle());
}
- mainPassage.add(title);
+ this.mainPassage.add(title);
}
/**
* displays a translator's change element
*
- * @param text
- * the text to be displayed
+ * @param text the text to be displayed
*/
public void createTransChange(final String text) {
this.createLabel(text, RESOURCES.passage().transChange(), new InlineLabel());
@@ -168,8 +160,7 @@
/**
* creates a verse number
*
- * @param verseNumber
- * verse number
+ * @param verseNumber verse number
*/
public void createVerseNumber(final String verseNumber) {
this.createLabel(verseNumber, RESOURCES.passage().verseNumber(), new InlineLabel());
@@ -186,32 +177,29 @@
/**
* crates a label and returns it
*
- * @param text
- * the text to be displayed
- * @param style
- * the style to set on the element
- * @param label
- * the label to use instead of creating a new one!
+ * @param text the text to be displayed
+ * @param style the style to set on the element
+ * @param label the label to use instead of creating a new one!
*
*/
void createLabel(final String text, final String style, final Label label) {
- if (numLines == 1) {
+ if (this.numLines == 1) {
label.setText(text);
label.addStyleName(style);
- mainPassage.add(label);
+ this.mainPassage.add(label);
return;
}
createLabel(new String[] { text }, new String[] { style }, new Label[] { label });
}
- Label[] createLabel(final String text[], final String[] style, final Label[] label) {
+ Label[] createLabel(final String[] text, final String[] style, final Label[] label) {
// note this works, because the vertical panel implementation uses table
// layout I believe
final VerticalPanel interlinearWord = new VerticalPanel();
- final Label[] addedLabels = new Label[numLines];
+ final Label[] addedLabels = new Label[this.numLines];
- for (int ii = 0; ii < numLines; ii++) {
+ for (int ii = 0; ii < this.numLines; ii++) {
if (ii < text.length && !isEmpty(text[ii])) {
if (ii < label.length && label[ii] != null) {
@@ -232,7 +220,7 @@
}
interlinearWord.addStyleName(RESOURCES.passage().interlinear());
- mainPassage.add(interlinearWord);
+ this.mainPassage.add(interlinearWord);
return addedLabels;
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/ScriptureView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/ScriptureView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/ScriptureView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -27,8 +27,7 @@
//at java.lang.Thread.run(Thread.java:619)
/**
- * This view aims to show Scripture to the user. In order to do this, the user
- * can select a version from a dropdown. The
+ * This view aims to show Scripture to the user. In order to do this, the user can select a version from a dropdown. The
*
*
* @author cjburrell
@@ -39,8 +38,7 @@
private static final int SCRIPTURE_HOLDER_TOP = 20;
/**
- * a logical display of scripture, in that events can be attached to each of
- * the elements on this panel
+ * a logical display of scripture, in that events can be attached to each of the elements on this panel
*/
private Widget scriptureHolder;
private final BibleVersionsDropDownComposite bibleVersionsDropDown = new BibleVersionsDropDownComposite();
@@ -53,32 +51,32 @@
*
*/
public ScriptureView() {
- scripturePanel.add(bibleVersionsDropDown, 0, 0);
- scripturePanel.add(decorator, 0, SCRIPTURE_HOLDER_TOP);
+ this.scripturePanel.add(this.bibleVersionsDropDown, 0, 0);
+ this.scripturePanel.add(this.decorator, 0, SCRIPTURE_HOLDER_TOP);
// scripturePanel.add(optionsButtonWidget);
// layoutPanel.add(decorator);
- initWidget(scripturePanel);
+ initWidget(this.scripturePanel);
}
public void setScriptureHolder(final StepViewInterface passageView) {
this.scriptureHolder = passageView.getContainerWidget();
- decorator.add(scriptureHolder);
+ this.decorator.add(this.scriptureHolder);
}
@Override
public void setWidth(final String width) {
- scripturePanel.setWidth(width);
- scriptureHolder.setWidth(removePadding(width));
+ this.scripturePanel.setWidth(width);
+ this.scriptureHolder.setWidth(removePadding(width));
}
@Override
public void setHeight(final String height) {
- scripturePanel.setHeight(height);
+ this.scripturePanel.setHeight(height);
final Double heightInPixels = Double.valueOf(height.substring(0, height.length() - 2));
final double adjustedHeight = removePadding(heightInPixels - SCRIPTURE_HOLDER_TOP);
- scriptureHolder.setHeight(adjustedHeight + "px");
+ this.scriptureHolder.setHeight(adjustedHeight + "px");
// // bibleVersionsDropDown.setHeight(height);
// // finally reset the layer height
@@ -113,15 +111,15 @@
public void addVersion(final String area, final String language, final String versionInitials,
final String versionName) {
- bibleVersionsDropDown.addVersion(area, language, versionInitials, versionName);
+ this.bibleVersionsDropDown.addVersion(area, language, versionInitials, versionName);
}
public String getCurrentlySelectedVersion() {
- return bibleVersionsDropDown.getCurrentlySelectedVersion();
+ return this.bibleVersionsDropDown.getCurrentlySelectedVersion();
}
public HasSelectionHandlers<TreeItem> getVersionSelector() {
- return bibleVersionsDropDown.getVersionSelectorHandler();
+ return this.bibleVersionsDropDown.getVersionSelectorHandler();
}
public HasChangeHandlers getChangeHandlers() {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/StepView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/StepView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/StepView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -17,8 +17,7 @@
import com.tyndalehouse.step.web.client.presenter.display.StepDisplay;
/**
- * This View sets up the many different views and the layout of the Step
- * Application
+ * This View sets up the many different views and the layout of the Step Application
*
* @author cjburrell
*
@@ -26,97 +25,97 @@
public class StepView extends Composite implements StepDisplay {
private static final String VISIBLE = "visible";
private static final String INVISIBLE = "invisible";
+ private static final int SIDE_PANEL_LEFT = 0;
+ private static final int SIDE_PANEL_WIDTH = 80;
+ private static final int SCRIPTURE_PANEL_LEFT = SIDE_PANEL_LEFT + SIDE_PANEL_WIDTH;
+ private static final int FILTER_PANEL_LEFT = SIDE_PANEL_LEFT + SIDE_PANEL_WIDTH;
+ private static final int FILTER_PANEL_WIDTH = 700;
+ private static final int TOP_PANEL_TOP = 0;
+ private static final int TOP_PANEL_HEIGHT = 75;
+ private static final int COLUMN_TOP = TOP_PANEL_TOP + TOP_PANEL_HEIGHT;
+ private static final int COLUMN_BOTTOM = 10;
+ private static final int CENTER_PANEL_TOP = COLUMN_TOP + 50;
+ private static final int CENTER_PANEL_BOTTOM = COLUMN_BOTTOM + 50;
+ private static final int CENTER_PANEL_WIDTH = 120;
- final private SimplePanel topLeftPanel = new SimplePanel();
- final private SimplePanel topRightPanel = new SimplePanel();
- final private SimplePanel sidePanel = new SimplePanel();
- final private SimplePanel leftColumnPanel = new SimplePanel();
- final private SimplePanel centerPanel = new SimplePanel();
- final private SimplePanel rightColumnPanel = new SimplePanel();
- final private SimplePanel filterPanel = new SimplePanel();
- final private LayoutPanel stepPanelLayout = new LayoutPanel();
+ private final SimplePanel topLeftPanel = new SimplePanel();
+ private final SimplePanel topRightPanel = new SimplePanel();
+ private final SimplePanel sidePanel = new SimplePanel();
+ private final SimplePanel leftColumnPanel = new SimplePanel();
+ private final SimplePanel centerPanel = new SimplePanel();
+ private final SimplePanel rightColumnPanel = new SimplePanel();
+ private final SimplePanel filterPanel = new SimplePanel();
+ private final LayoutPanel stepPanelLayout = new LayoutPanel();
- final private static int SIDE_PANEL_LEFT = 0;
- final private static int SIDE_PANEL_WIDTH = 80;
- final private static int SCRIPTURE_PANEL_LEFT = SIDE_PANEL_LEFT + SIDE_PANEL_WIDTH;
- final private static int FILTER_PANEL_LEFT = SIDE_PANEL_LEFT + SIDE_PANEL_WIDTH;
- final private static int FILTER_PANEL_WIDTH = 700;
- final private static int TOP_PANEL_TOP = 0;
- final private static int TOP_PANEL_HEIGHT = 75;
- final private static int COLUMN_TOP = TOP_PANEL_TOP + TOP_PANEL_HEIGHT;
- final private static int COLUMN_BOTTOM = 10;
- final private static int CENTER_PANEL_TOP = COLUMN_TOP + 50;
- final private static int CENTER_PANEL_BOTTOM = COLUMN_BOTTOM + 50;
- final private static int CENTER_PANEL_WIDTH = 120;
-
/**
- * Main STEP entry view, sets up the layout in a pluggable and replaceable
- * way
+ * Main STEP entry view, sets up the layout in a pluggable and replaceable way
*/
public StepView() {
addPanelsToLayout();
setInitialLayout();
- initWidget(stepPanelLayout);
+ initWidget(this.stepPanelLayout);
}
private void addPanelsToLayout() {
- stepPanelLayout.add(topLeftPanel);
- stepPanelLayout.add(topRightPanel);
- stepPanelLayout.add(sidePanel);
- stepPanelLayout.add(leftColumnPanel);
- stepPanelLayout.add(centerPanel);
- stepPanelLayout.add(rightColumnPanel);
- stepPanelLayout.add(filterPanel);
+ this.stepPanelLayout.add(this.topLeftPanel);
+ this.stepPanelLayout.add(this.topRightPanel);
+ this.stepPanelLayout.add(this.sidePanel);
+ this.stepPanelLayout.add(this.leftColumnPanel);
+ this.stepPanelLayout.add(this.centerPanel);
+ this.stepPanelLayout.add(this.rightColumnPanel);
+ this.stepPanelLayout.add(this.filterPanel);
// set z-indexes
- final Style sidePanelStyle = stepPanelLayout.getWidgetContainerElement(sidePanel).getStyle();
+ final Style sidePanelStyle = this.stepPanelLayout.getWidgetContainerElement(this.sidePanel).getStyle();
sidePanelStyle.setZIndex(1000);
sidePanelStyle.setBackgroundColor("#BCD56D");
- stepPanelLayout.getWidgetContainerElement(leftColumnPanel).getStyle().setZIndex(1000);
- stepPanelLayout.getWidgetContainerElement(centerPanel).getStyle().setZIndex(1000);
+ this.stepPanelLayout.getWidgetContainerElement(this.leftColumnPanel).getStyle().setZIndex(1000);
+ this.stepPanelLayout.getWidgetContainerElement(this.centerPanel).getStyle().setZIndex(1000);
- final Style filterPanelStyle = stepPanelLayout.getWidgetContainerElement(filterPanel).getStyle();
+ final Style filterPanelStyle = this.stepPanelLayout.getWidgetContainerElement(this.filterPanel).getStyle();
filterPanelStyle.setZIndex(2000);
filterPanelStyle.setBackgroundColor("#BCD56D");
}
private void setInitialLayout() {
- stepPanelLayout.setWidgetTopHeight(topLeftPanel, TOP_PANEL_TOP, Unit.PX, TOP_PANEL_HEIGHT, Unit.PX);
- stepPanelLayout.setWidgetTopHeight(topRightPanel, TOP_PANEL_TOP, Unit.PX, TOP_PANEL_HEIGHT, Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(sidePanel, SIDE_PANEL_LEFT, Unit.PX, SIDE_PANEL_WIDTH, Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(filterPanel, FILTER_PANEL_LEFT, Unit.PX, FILTER_PANEL_WIDTH, Unit.PX);
- stepPanelLayout.setWidgetTopBottom(leftColumnPanel, COLUMN_TOP, Unit.PX, COLUMN_BOTTOM, Unit.PX);
- stepPanelLayout.setWidgetTopBottom(rightColumnPanel, COLUMN_TOP, Unit.PX, COLUMN_BOTTOM, Unit.PX);
- stepPanelLayout.setWidgetTopBottom(centerPanel, CENTER_PANEL_TOP, Unit.PX, CENTER_PANEL_BOTTOM, Unit.PX);
+ this.stepPanelLayout.setWidgetTopHeight(this.topLeftPanel, TOP_PANEL_TOP, Unit.PX, TOP_PANEL_HEIGHT, Unit.PX);
+ this.stepPanelLayout.setWidgetTopHeight(this.topRightPanel, TOP_PANEL_TOP, Unit.PX, TOP_PANEL_HEIGHT, Unit.PX);
+ this.stepPanelLayout.setWidgetLeftWidth(this.sidePanel, SIDE_PANEL_LEFT, Unit.PX, SIDE_PANEL_WIDTH, Unit.PX);
+ this.stepPanelLayout.setWidgetLeftWidth(this.filterPanel, FILTER_PANEL_LEFT, Unit.PX, FILTER_PANEL_WIDTH,
+ Unit.PX);
+ this.stepPanelLayout.setWidgetTopBottom(this.leftColumnPanel, COLUMN_TOP, Unit.PX, COLUMN_BOTTOM, Unit.PX);
+ this.stepPanelLayout.setWidgetTopBottom(this.rightColumnPanel, COLUMN_TOP, Unit.PX, COLUMN_BOTTOM, Unit.PX);
+ this.stepPanelLayout.setWidgetTopBottom(this.centerPanel, CENTER_PANEL_TOP, Unit.PX, CENTER_PANEL_BOTTOM,
+ Unit.PX);
}
public void setLeftColumn(final StepViewInterface w) {
- replaceContents(leftColumnPanel, w);
+ replaceContents(this.leftColumnPanel, w);
}
public void setFilterPanel(final StepViewInterface w) {
- replaceContents(filterPanel, w);
+ replaceContents(this.filterPanel, w);
}
public void setRightColumn(final StepViewInterface w) {
- replaceContents(rightColumnPanel, w);
+ replaceContents(this.rightColumnPanel, w);
}
public void setSideBar(final StepViewInterface w) {
- replaceContents(sidePanel, w);
+ replaceContents(this.sidePanel, w);
}
public void setTopLeftPanel(final StepViewInterface w) {
- replaceContents(topLeftPanel, w);
+ replaceContents(this.topLeftPanel, w);
}
public void setTopRightPanel(final StepViewInterface w) {
- replaceContents(topRightPanel, w);
+ replaceContents(this.topRightPanel, w);
}
public void setCenterPanel(final StepViewInterface w) {
- replaceContents(centerPanel, w);
+ replaceContents(this.centerPanel, w);
}
private void replaceContents(final Panel p, final StepViewInterface w) {
@@ -143,38 +142,39 @@
}
/**
- * repositions boxes around the screen to ensure they are always where they
- * should be and visible
+ * repositions boxes around the screen to ensure they are always where they should be and visible
*/
public void reLay() {
final int windowHeight = Window.getClientHeight();
final int windowWidth = Window.getClientWidth();
- final int sidePanelHeight = sidePanel.getWidget().getOffsetHeight();
+ final int sidePanelHeight = this.sidePanel.getWidget().getOffsetHeight();
final int centerPanelLeft = (windowWidth - CENTER_PANEL_WIDTH + SIDE_PANEL_WIDTH) / 2;
final int columnWidth = (windowWidth - CENTER_PANEL_WIDTH - SIDE_PANEL_WIDTH) / 2;
final int columnHeight = windowHeight - COLUMN_TOP - COLUMN_BOTTOM;
- repositionVertically(sidePanel, windowHeight, sidePanelHeight);
- repositionVertically(filterPanel, windowHeight, sidePanelHeight);
- stepPanelLayout.setWidgetLeftWidth(centerPanel, centerPanelLeft, Unit.PX, CENTER_PANEL_WIDTH, Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(topLeftPanel, SCRIPTURE_PANEL_LEFT, Unit.PX, columnWidth, Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(leftColumnPanel, SCRIPTURE_PANEL_LEFT, Unit.PX, columnWidth, Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(topRightPanel, centerPanelLeft + CENTER_PANEL_WIDTH, Unit.PX, columnWidth,
+ repositionVertically(this.sidePanel, windowHeight, sidePanelHeight);
+ repositionVertically(this.filterPanel, windowHeight, sidePanelHeight);
+ this.stepPanelLayout
+ .setWidgetLeftWidth(this.centerPanel, centerPanelLeft, Unit.PX, CENTER_PANEL_WIDTH, Unit.PX);
+ this.stepPanelLayout.setWidgetLeftWidth(this.topLeftPanel, SCRIPTURE_PANEL_LEFT, Unit.PX, columnWidth, Unit.PX);
+ this.stepPanelLayout.setWidgetLeftWidth(this.leftColumnPanel, SCRIPTURE_PANEL_LEFT, Unit.PX, columnWidth,
Unit.PX);
- stepPanelLayout.setWidgetLeftWidth(rightColumnPanel, centerPanelLeft + CENTER_PANEL_WIDTH, Unit.PX,
+ this.stepPanelLayout.setWidgetLeftWidth(this.topRightPanel, centerPanelLeft + CENTER_PANEL_WIDTH, Unit.PX,
columnWidth, Unit.PX);
+ this.stepPanelLayout.setWidgetLeftWidth(this.rightColumnPanel, centerPanelLeft + CENTER_PANEL_WIDTH, Unit.PX,
+ columnWidth, Unit.PX);
// TODO: change to set size?
- filterPanel.getWidget().setHeight(valueOf(sidePanelHeight) + "px");
- filterPanel.getWidget().setWidth(valueOf(StepView.FILTER_PANEL_WIDTH) + "px");
- sidePanel.getWidget().setHeight(valueOf(sidePanelHeight) + "px");
- sidePanel.getWidget().setWidth(valueOf(StepView.SIDE_PANEL_WIDTH) + "px");
- centerPanel.getWidget().setHeight(valueOf(windowHeight - CENTER_PANEL_TOP - CENTER_PANEL_BOTTOM) + "px");
- centerPanel.getWidget().setWidth(valueOf(CENTER_PANEL_WIDTH) + "px");
- leftColumnPanel.getWidget().setWidth(valueOf(columnWidth) + "px");
- leftColumnPanel.getWidget().setHeight(valueOf(columnHeight) + "px");
- rightColumnPanel.getWidget().setWidth(valueOf(columnWidth) + "px");
- rightColumnPanel.getWidget().setHeight(valueOf(columnHeight) + "px");
+ this.filterPanel.getWidget().setHeight(valueOf(sidePanelHeight) + "px");
+ this.filterPanel.getWidget().setWidth(valueOf(StepView.FILTER_PANEL_WIDTH) + "px");
+ this.sidePanel.getWidget().setHeight(valueOf(sidePanelHeight) + "px");
+ this.sidePanel.getWidget().setWidth(valueOf(StepView.SIDE_PANEL_WIDTH) + "px");
+ this.centerPanel.getWidget().setHeight(valueOf(windowHeight - CENTER_PANEL_TOP - CENTER_PANEL_BOTTOM) + "px");
+ this.centerPanel.getWidget().setWidth(valueOf(CENTER_PANEL_WIDTH) + "px");
+ this.leftColumnPanel.getWidget().setWidth(valueOf(columnWidth) + "px");
+ this.leftColumnPanel.getWidget().setHeight(valueOf(columnHeight) + "px");
+ this.rightColumnPanel.getWidget().setWidth(valueOf(columnWidth) + "px");
+ this.rightColumnPanel.getWidget().setHeight(valueOf(columnHeight) + "px");
// resizeDecoratedPanel(filterPanel, StepView.FILTER_PANEL_WIDTH,
// sidePanelHeight);
@@ -220,7 +220,7 @@
final Widget childWidget = childPanel.getWidget();
if (childWidget != null) {
final int newGap = (windowHeight - widgetHeight) / 2;
- stepPanelLayout.setWidgetTopBottom(childPanel, newGap, Unit.PX, newGap, Unit.PX);
+ this.stepPanelLayout.setWidgetTopBottom(childPanel, newGap, Unit.PX, newGap, Unit.PX);
}
}
@@ -228,7 +228,7 @@
* sets the visibility of the side par
*/
public void setFilterPanelVisible(final boolean visible) {
- final Element widgetContainerElement = stepPanelLayout.getWidgetContainerElement(filterPanel);
+ final Element widgetContainerElement = this.stepPanelLayout.getWidgetContainerElement(this.filterPanel);
widgetContainerElement.removeClassName(visible ? StepView.INVISIBLE : StepView.VISIBLE);
widgetContainerElement.addClassName(visible ? StepView.VISIBLE : StepView.INVISIBLE);
}
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimebandListView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimebandListView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimebandListView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -14,10 +14,8 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.helpers.CurrentBandStats;
/**
- * The timeband list view is a list of timebands. The list includes numbers of
- * events currently on the timeband and the number of events that could be
- * shown, in the visible section, of the timeband should the user express
- * interest
+ * The timeband list view is a list of timebands. The list includes numbers of events currently on the timeband and the
+ * number of events that could be shown, in the visible section, of the timeband should the user express interest
*
* @author cjburrell
*
@@ -41,8 +39,7 @@
/**
* The default constructor
*
- * @param eventBus
- * TODO: TO BE REMOVED
+ * @param eventBus TODO: TO BE REMOVED
*/
// @Inject
public TimebandListView(/* final EventBus eventBus */) {
@@ -67,9 +64,7 @@
/**
* method called to update the list of timebands with the latest statistics
*
- * @param stats
- * is a list of current numbers of events (total/visible) on each
- * timeband
+ * @param stats is a list of current numbers of events (total/visible) on each timeband
*/
// TODO: should the event adding somehow be moved into the presenter?
public void updateList(final List<CurrentBandStats> stats) {
Modified: trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimelineView.java
===================================================================
--- trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimelineView.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/main/java/com/tyndalehouse/step/web/client/view/TimelineView.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -10,12 +10,10 @@
import com.tyndalehouse.step.web.client.toolkit.timeline.Timeline;
/**
- * the timeline view is a wrapper around the whole timeline component used for
- * displaying events stored in the database. These events can be point-in-time
- * or in duration.
+ * the timeline view is a wrapper around the whole timeline component used for displaying events stored in the database.
+ * These events can be point-in-time or in duration.
*
- * A timeline is split into a timebands, which are then split in to time tracks.
- * The events are added to a timetrack
+ * A timeline is split into a timebands, which are then split in to time tracks. The events are added to a timetrack
*
* @author cjburrell
*
@@ -40,8 +38,7 @@
/**
* Default constructor TODO: remove eventBus
*
- * @param eventBus
- * remove event bus from here
+ * @param eventBus remove event bus from here
*/
// @Inject
public TimelineView(/* final EventBus eventBus */) {
Modified: trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenterTest.java
===================================================================
--- trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenterTest.java 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/BookmarkPresenterTest.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -18,8 +18,7 @@
public class BookmarkPresenterTest extends MockTest {
/**
- * tests that removing a bookmark does it from the view and the internal
- * list
+ * tests that removing a bookmark does it from the view and the internal list
*
* <pre>
* blah2
Added: trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/PassagePresenterTest.java
===================================================================
--- trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/PassagePresenterTest.java (rev 0)
+++ trunk/step-web-app/src/test/java/com/tyndalehouse/step/web/client/presenter/PassagePresenterTest.java 2010-08-27 12:34:09 UTC (rev 174)
@@ -0,0 +1,329 @@
+package com.tyndalehouse.step.web.client.presenter;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+import org.junit.Test;
+
+import com.tyndalehouse.step.web.shared.scripture.Passage;
+
+public class PassagePresenterTest extends MockTest {
+
+ /**
+ * @return the current passage reference
+ */
+ @Test
+ public void testGetPassageReference() {
+ final PassagePresenter pp = new PassagePresenter(null);
+ assertNull(pp.getPassageReference());
+ final Passage p = new Passage();
+ p.setReference("Genesis 1:1");
+ assertEquals("Genesis 1:1", pp.getPassageReference());
+ }
+
+ /**
+ * tests that we add an option handler
+ */
+ public void testBind() {
+ // super.getMock().mock(PassageDisplay.class);
+ // PassageDisplay mockView = Mockito.mock(PassageDisplay.class);
+ // PassagePresenter pp = new PassagePresenter(null);
+ // pp.setView(mockView);
+ // pp.bind();
+ //
+ // Mockito.times(1).verify(new VerificationData())
+ // verify(mockView).addOptionHandler(null);
+ //
+
+ //
+ // view.addOptionHandler(new OptionHandler() {
+ // public void onOptionSelected(final OptionEvent oe) {
+ // refreshPassage(oe);
+ // }
+ // });
+ }
+
+ // /**
+ // * refreshes the view by calling the server
+ // *
+ // * @param newReference
+ // * the reference to be displayed
+ // * @param newVersion
+ // * the version to select
+ // */
+ // void refreshViewFromServer(final String newReference, final String
+ // newVersion) {
+ // if (isNotEmpty(newVersion) && isNotEmpty(newReference)) {
+ // final GetCurrentBibleTextCommand cmd = new
+ // GetCurrentBibleTextCommand(newVersion, newReference);
+ // cmd.setDisplayOptions(view.getSelectedOptions());
+ //
+ // dispatcher.execute(cmd, new AsyncCallback<GetCurrentBibleTextResult>() {
+ // public void onFailure(final Throwable e) {
+ // Log.error("An error has occurred", e);
+ // }
+ //
+ // public void onSuccess(final GetCurrentBibleTextResult result) {
+ // passage = result.getPassage();
+ // passage.setReference(newReference);
+ // passage.setVersion(newVersion);
+ //
+ // renderPassage();
+ // // view.setPassage(result.getPassage());
+ // eventBus.scriptureChangedSuccessfully(result.getReadableKey());
+ // }
+ // });
+ // }
+ // }
+ //
+ // /**
+ // * renders the passage in the view, by doing all the business logic and
+ // * manipulation here, and letting the view do the display
+ // *
+ // * @param selectedOptions
+ // * currently selected options defining the features to be
+ // * displayed on the passage
+ // *
+ // */
+ // void renderPassage() {
+ // final Map<String, ScriptureDisplayOptions> selectedOptions =
+ // view.getSelectedOptions();
+ // view.clearPassage();
+ // Log.info("" + System.currentTimeMillis());
+ // final List<PassageElement> passageElements =
+ // passage.getRootPassageNode().getChildren();
+ //
+ // for (final PassageElement passageElement : passageElements) {
+ // renderPassageElement(passageElement, selectedOptions);
+ // }
+ // }
+ //
+ // /**
+ // * renders individual passage elements onto the view, dependendant on
+ // their
+ // * type, etc.
+ // *
+ // * @param passageElement
+ // * the passage element to be rendered, for e.g. a WORD
+ // * @param selectedOptions
+ // * the options that are currently selected in this view
+ // */
+ // private void renderPassageElement(final PassageElement passageElement,
+ // final Map<String, ScriptureDisplayOptions> selectedOptions) {
+ //
+ // switch (passageElement.getTypeOfElement()) {
+ // case TITLE:
+ // view.createTitle(getText(passageElement));
+ // break;
+ // case VERSE:
+ // // we simply add all the children
+ // final List<PassageElement> children = passageElement.getChildren();
+ // boolean alreadyInsertedVerseNumber = false;
+ // for (final PassageElement child : children) {
+ // if (selectedOptions.containsKey(VERSE_NUMBERS.name()) &&
+ // !alreadyInsertedVerseNumber) {
+ // alreadyInsertedVerseNumber |=
+ // doVerseNumber(passageElement.getAttribute(OSIS_ID), child);
+ // }
+ // renderPassageElement(child, selectedOptions);
+ // }
+ // break;
+ // case WORD:
+ // case TEXT:
+ // doWord(passageElement, selectedOptions);
+ // break;
+ // case LINE_BREAK:
+ // view.createLineBreak();
+ // break;
+ // case QUOTE:
+ // // if quote has children, then render those instead
+ // if (passageElement.getNumChildren() != 0) {
+ // for (final PassageElement child : passageElement.getChildren()) {
+ // doQuote(child);
+ // }
+ // } else {
+ // doQuote(passageElement);
+ // }
+ // break;
+ // case TRANS_CHANGE:
+ // view.createTransChange(getText(passageElement));
+ // break;
+ // default:
+ // Log.warn("Unrendered element of type: " +
+ // passageElement.getTypeOfElement());
+ // break;
+ // }
+ // }
+ //
+ // /**
+ // * business logic around translating a passage element into a word to be
+ // * displayed on the screen
+ // *
+ // * @param passageElement
+ // * the passageElement
+ // * @param selectedOptions
+ // * the selectedOptions currently on the screen.
+ // */
+ // void doWord(final PassageElement passageElement, final Map<String,
+ // ScriptureDisplayOptions> selectedOptions) {
+ // final String alternativeWording =
+ // passageElement.getAttribute(ALTERNATIVE_WORDING);
+ // final HasClickAndHighlightHandlers wordHandler =
+ // view.createText(getText(passageElement), alternativeWording);
+ // final String lemmaAttribute = passageElement.getAttribute(LEMMA);
+ //
+ // if (lemmaAttribute != null) {
+ // // IMPROVEMENT: this could happen server side, and save
+ // // ops in the browser
+ // final String[] lemmas = lemmaAttribute.split(" ");
+ // for (int ii = 0; ii < lemmas.length; ii++) {
+ // if
+ // (selectedOptions.containsKey(ScriptureDisplayOptions.SHOW_LEMMAS.name()))
+ // {
+ // view.createLemmaTag(lemmas[ii].replaceAll("strong:", ""));
+ // }
+ // addHighlitableWord(lemmas[ii], wordHandler);
+ // }
+ //
+ // wordHandler.addClickHandler(new ClickHandler() {
+ // public void onClick(final ClickEvent clickEvent) {
+ // getEventBus().selectedLemmas(lemmas);
+ // }
+ // });
+ // }
+ //
+ // }
+ //
+ // /**
+ // * safely adds a word to the highlightable map
+ // *
+ // * @param lemma
+ // * the lemma associated to the word = the key of the map
+ // * @param wordHandler
+ // * a word which can be highlighted
+ // */
+ // void addHighlitableWord(final String lemma, final
+ // HasClickAndHighlightHandlers wordHandler) {
+ // List<HasClickAndHighlightHandlers> words =
+ // this.highlightableWords.get(lemma);
+ // if (words == null) {
+ // words = new ArrayList<HasClickAndHighlightHandlers>();
+ // this.highlightableWords.put(lemma, words);
+ // }
+ // words.add(wordHandler);
+ // }
+ //
+ // /**
+ // * highlights all the words in the highlightable map
+ // *
+ // * @param lemmas
+ // * the list of lemmas associated with the clicked word
+ // */
+ // public void onSelectedLemmas(final String[] lemmas) {
+ // final Set<String> lemmaSet = new HashSet<String>();
+ // for (final String lemma : lemmas) {
+ // lemmaSet.add(lemma);
+ // }
+ //
+ // for (final Entry<String, List<HasClickAndHighlightHandlers>> words :
+ // highlightableWords.entrySet()) {
+ // final boolean highlightableList = lemmaSet.contains(words.getKey());
+ // for (final HasClickAndHighlightHandlers w : words.getValue()) {
+ // w.highlight(highlightableList);
+ // }
+ // }
+ // }
+ //
+ // /**
+ // * renders a quote on the passage view
+ // *
+ // * @param passageElement
+ // * the element to render
+ // */
+ // void doQuote(final PassageElement passageElement) {
+ // final String markerAttribute =
+ // passageElement.getAttribute(OsisElementType.MARKER);
+ // if (markerAttribute != null) {
+ // view.createQuote(markerAttribute);
+ // } else {
+ // view.createQuote(getText(passageElement));
+ // }
+ // }
+ //
+ // /**
+ // * adds a verse number if other renderable items have been rendered
+ // *
+ // * @param childVerseNode
+ // * the child node of a verse
+ // * @return true if the verse number was inserted
+ // */
+ // boolean doVerseNumber(final String osisIdAttribute, final PassageElement
+ // childVerseNode) {
+ // if (!OsisElementType.TITLE.equals(childVerseNode.getTypeOfElement())) {
+ // view.createVerseNumber(getVerseNumberFromOsisId(osisIdAttribute));
+ // return true;
+ // }
+ // return false;
+ // }
+ //
+ // /**
+ // * returns the text from a passage element, which can either be stored
+ // * directly as text or as a TEXT node and then text
+ // *
+ // * @param passageElement
+ // * the passage element to retrieve text from
+ // * @return the text itself
+ // */
+ // String getText(final PassageElement passageElement) {
+ // if (passageElement != null) {
+ // final PassageElement textNode =
+ // OsisElementType.TEXT.equals(passageElement.getTypeOfElement()) ?
+ // passageElement
+ // : passageElement.getFirstChild();
+ //
+ // if (textNode != null) {
+ // return textNode.getAttribute(OsisElementType.TEXT);
+ // }
+ // }
+ //
+ // return "";
+ // }
+ //
+ // /**
+ // * either does the refresh if it is possible, without asking the server or
+ // * return false
+ // *
+ // * @param oe
+ // * the event triggering this refresh the selected option
+ // * @return true if a refresh was done
+ // */
+ // boolean refreshIfDataAlreadyObtained(final OptionEvent oe) {
+ // // final Passage p = view.getPassage();
+ // final Set<OsisElementType> attributeFilter =
+ // passage.getAttributeFilter();
+ // final Set<OsisElementType> elementFilter = passage.getElementFilter();
+ //
+ // if (!oe.isAddingData()) {
+ // renderPassage();
+ // }
+ //
+ // switch (oe.getSelectedOption()) {
+ // case VERSE_NUMBERS:
+ // if (!(elementFilter.contains(VERSE) &&
+ // attributeFilter.contains(OSIS_ID))) {
+ // return false;
+ // }
+ // renderPassage();
+ // return true;
+ // case SHOW_LEMMAS:
+ // if (!attributeFilter.contains(LEMMA)) {
+ // return false;
+ // }
+ // renderPassage();
+ // return true;
+ // default:
+ // return false;
+ // }
+ // }
+
+}
Modified: trunk/step-web-app/step.launch
===================================================================
--- trunk/step-web-app/step.launch 2010-08-09 19:18:30 UTC (rev 173)
+++ trunk/step-web-app/step.launch 2010-08-27 12:34:09 UTC (rev 174)
@@ -9,9 +9,20 @@
<listAttribute key="org.eclipse.debug.core.MAPPED_RESOURCE_TYPES">
<listEntry value="4"/>
</listAttribute>
+<listAttribute key="org.eclipse.jdt.launching.CLASSPATH">
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry containerPath="org.eclipse.jdt.launching.JRE_CONTAINER" javaProject="step-web-app" path="1" type="4"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-app/src/main/java" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-app/src/main/resources" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-server/src/main/java" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-server/src/main/resources" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-shared/src/main/java" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry internalArchive="/step-web-shared/src/main/resources" path="3" type="2"/> "/>
+<listEntry value="<?xml version="1.0" encoding="UTF-8" standalone="no"?> <runtimeClasspathEntry id="org.eclipse.jdt.launching.classpathentry.defaultClasspath"> <memento exportedEntriesOnly="false" project="step-web-app"/> </runtimeClasspathEntry> "/>
+</listAttribute>
<stringAttribute key="org.eclipse.jdt.launching.CLASSPATH_PROVIDER" value="com.google.gwt.eclipse.core.moduleClasspathProvider"/>
+<booleanAttribute key="org.eclipse.jdt.launching.DEFAULT_CLASSPATH" value="false"/>
<stringAttribute key="org.eclipse.jdt.launching.MAIN_TYPE" value="com.google.gwt.dev.DevMode"/>
-<stringAttribute key="org.eclipse.jdt.launching.PROGRAM_ARGUMENTS" value="-remoteUI "${gwt_remote_ui_server_port}:${unique_id}" -startupUrl step/Step.html -war D:\Personal\step\step-web-app\war -logLevel INFO -port 8888 com.tyndalehouse.step.web.step"/>
+<stringAttribute key="org.eclipse.jdt.launching.PROGRAM_ARGUMENTS" value="-remoteUI "${gwt_remote_ui_server_port}:${unique_id}" -startupUrl step/Step.html -war D:\Personal\step\step-web-app\src\main\webapp -logLevel INFO -port 8888 com.tyndalehouse.step.web.step"/>
<stringAttribute key="org.eclipse.jdt.launching.PROJECT_ATTR" value="step-web-app"/>
<stringAttribute key="org.eclipse.jdt.launching.VM_ARGUMENTS" value="-Xmx512m -Dgwt.nowarn.legacy.tools "-Dconnection.string=jdbc:derby:${system_property:user.home}/TyndaleStep/StepDB" -Ddb.driver=org.apache.derby.jdbc.ClientDriver"/>
</launchConfiguration>
More information about the Tynstep-svn
mailing list