Skip to content

Commit

Permalink
Reduce visibility, javadoc cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
ccavanaugh committed Jun 25, 2016
1 parent 20cc7a1 commit ea17fc5
Show file tree
Hide file tree
Showing 33 changed files with 68 additions and 48 deletions.
14 changes: 8 additions & 6 deletions jgnash-fx/src/main/java/jgnash/uifx/StaticUIMethods.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import jgnash.util.ResourceUtils;

/**
* Various static UI support methods
* Various static UI support methods.
*
* @author Craig Cavanaugh
*/
Expand All @@ -51,7 +51,8 @@ private StaticUIMethods() {
}

public static void showOpenDialog() {
final FXMLUtils.Pair<OpenDatabaseController> pair = FXMLUtils.load(OpenDatabaseController.class.getResource("OpenDatabaseForm.fxml"),
final FXMLUtils.Pair<OpenDatabaseController> pair
= FXMLUtils.load(OpenDatabaseController.class.getResource("OpenDatabaseForm.fxml"),
ResourceUtils.getBundle().getString("Title.Open"));

pair.getStage().setResizable(false);
Expand Down Expand Up @@ -89,7 +90,7 @@ public static void displayWarning(final String message) {
}

/**
* Displays a Yes and No dialog requesting confirmation
* Displays a Yes and No dialog requesting confirmation.
*
* @param title Dialog title
* @param message Dialog message
Expand Down Expand Up @@ -119,7 +120,7 @@ public static void displayTaskProgress(final Task<?> task) {


/**
* Returns the primary application icon
* Returns the primary application icon.
*
* @return {@code} Image or {@code null} if not found
*/
Expand All @@ -139,13 +140,14 @@ public static synchronized Image getApplicationIcon() {
}

/**
* Handler for displaying uncaught exceptions
* Handler for displaying uncaught exceptions.
*/
public static class ExceptionHandler implements Thread.UncaughtExceptionHandler {

@Override
public void uncaughtException(final Thread t, final Throwable throwable) {
Logger.getLogger(ExceptionHandler.class.getName()).log(Level.SEVERE, throwable.getLocalizedMessage(), throwable);
Logger.getLogger(ExceptionHandler.class.getName())
.log(Level.SEVERE, throwable.getLocalizedMessage(), throwable);

displayException(throwable);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
import jgnash.util.ResourceUtils;

/**
* About Dialog
* About Dialog.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
import jgnash.util.Nullable;

/**
* Abstract Controller handling a {@code TreeView} of {@code Account}s
* Abstract Controller handling a {@code TreeView} of {@code Account}s.
*
* @author Craig Cavanaugh
*/
Expand All @@ -52,7 +52,7 @@ public abstract class AbstractAccountTreeController implements MessageListener {
protected abstract TreeView<Account> getTreeView();

/**
* Determines account visibility
* Determines account visibility.
*
* @param account {@code Account} to determine visibility based on filter state
* @return {@code true} if the {@code Account} should be visible
Expand All @@ -64,7 +64,7 @@ public abstract class AbstractAccountTreeController implements MessageListener {
final private ObservableSet<Account> filteredAccounts = FXCollections.observableSet(new TreeSet<>());

/**
* Adds accounts to be excluded from the list of selectable accounts
* Adds accounts to be excluded from the list of selectable accounts.
*
* @param filteredAccountsList collection of {@code Account} that should be excluded regardless
* of {@code isAccountVisible()}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import jgnash.time.DateUtils;

/**
* {@code TableCell} for {@code Dates} formatted in a simplified manner
* {@code TableCell} for {@code Dates} formatted in a simplified manner.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
import javafx.scene.layout.BorderPane;

/**
* Extended TabPane for consistent view creation
* Extended TabPane for consistent view creation.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
import jgnash.util.ResourceUtils;

/**
* A better behaved TextInputDialog
* A better behaved TextInputDialog.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
import jgnash.uifx.util.InjectFXML;

/**
* Utility Dialog/Controller for collection remote database connection information
* Utility Dialog/Controller for collection remote database connection information.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import jgnash.ui.report.jasper.ReportFactory;

/**
* Controller for Report Options
* Controller for Report Options.
*
* @author Craig Cavanaguh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import jgnash.uifx.Options;

/**
* Controller for Startup and Shutdown options
* Controller for Startup and Shutdown options.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
import jgnash.util.ResourceUtils;

/**
* Controller for editing the list of available transaction numbers
* Controller for editing the list of available transaction numbers.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
import jgnash.util.ResourceUtils;

/**
* Security history controller
* Security history controller.
*
* @author Craig Cavanaugh
*/
Expand Down
2 changes: 1 addition & 1 deletion jgnash-fx/src/main/java/jgnash/uifx/skin/StyleClass.java
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
package jgnash.uifx.skin;

/**
* Global Styles
* Global Styles.
*
* @author Craig Cavanaugh
*/
Expand Down
6 changes: 3 additions & 3 deletions jgnash-fx/src/main/java/jgnash/uifx/skin/ThemeManager.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
import jgnash.util.OS;

/**
* Theme manager
* Theme manager.
*
* @author Craig Cavanaugh
*/
Expand Down Expand Up @@ -203,7 +203,7 @@ static String getCurrentTheme() {
}

/**
* Utility method to discover the {@code Paint} used for {@code Button} text
* Utility method to discover the {@code Paint} used for {@code Button} text.
*
* @return Base Paint used for Buttons
*/
Expand All @@ -216,7 +216,7 @@ private static Paint getBaseTextColor() {
}

/**
* Utility method to discover the base font size in pixels
* Utility method to discover the base font size in pixels.
*
* @return font size in pixels
*/
Expand Down
2 changes: 1 addition & 1 deletion jgnash-fx/src/main/java/jgnash/uifx/tasks/SaveAsTask.java
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import jgnash.util.ResourceUtils;

/**
* Save File As Task
* Save File As Task.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ public class TableViewManager<S> {
private static final Logger logger = Logger.getLogger(TableViewManager.class.getName());

/**
* Limits number of processed visibility change events ensuring the most recent is executed
* Limits number of processed visibility change events ensuring the most recent is executed.
*/
private final ThreadPoolExecutor updateColumnVisibilityExecutor;

Expand Down Expand Up @@ -119,7 +119,7 @@ private void removeColumnListeners() {
}

/**
* Determines the preferred width of the column including contents
* Determines the preferred width of the column including contents.
*
* @param column {@code TableColumn} to measure content
* @return preferred width
Expand Down
2 changes: 1 addition & 1 deletion jgnash-fx/src/main/java/jgnash/uifx/util/TreeSearch.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import javafx.scene.control.TreeItem;

/**
* Utility class to search through a JavaFX tree
* Utility class to search through a JavaFX tree.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
import jgnash.util.NotNull;

/**
* Controller for selecting an account from a tree
* Controller for selecting an account from a tree.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
import jgnash.util.ResourceUtils;

/**
* Static support methods for Account manipulation
* Static support methods for Account manipulation.
*
* @author Craig Cavanaugh
*/
Expand Down
8 changes: 4 additions & 4 deletions jgnash-fx/src/main/java/jgnash/uifx/views/main/StatusBar.java
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import jgnash.util.ResourceUtils;

/**
* Status bar
* Status bar.
*
* @author Craig Cavanaugh
*/
Expand All @@ -46,7 +46,7 @@ class StatusBar extends StackPane {

private final DoubleProperty progress = new SimpleDoubleProperty(this, "progress");

public StatusBar() {
StatusBar() {
getStyleClass().add("status-bar");

final Label label = new Label();
Expand Down Expand Up @@ -85,7 +85,7 @@ public final StringProperty textProperty() {
*
* @return the property used for storing a graphic node
*/
public final ObjectProperty<Node> graphicProperty() {
final ObjectProperty<Node> graphicProperty() {
return graphic;
}

Expand All @@ -95,7 +95,7 @@ public final ObjectProperty<Node> graphicProperty() {
*
* @return the property used to store the progress of a task
*/
public final DoubleProperty progressProperty() {
final DoubleProperty progressProperty() {
return progress;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
import jgnash.util.NotNull;

/**
* Return of Capital entry controller
* Return of Capital entry controller.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import jgnash.util.NotNull;

/**
* Transaction Entry Controller for Credits and Debits
* Transaction Entry Controller for Credits and Debits.
*
* @author Craig Cavanaugh
*/
Expand Down
10 changes: 6 additions & 4 deletions jgnash-fx/src/main/java/jgnash/uifx/views/register/Slip.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,21 @@
import jgnash.util.NotNull;

/**
* @author Craig Cavanaugh
* Transaction slip interface.
*
* @author Craig Cavanaugh.
*/
public interface Slip extends BaseSlip {
interface Slip extends BaseSlip {

/**
* Loads a {@code Transaction} into the form and sets it up for modification
* Loads a {@code Transaction} into the form and sets it up for modification.
*
* @param transaction {@code Transaction} to load for modification
*/
void modifyTransaction(@NotNull final Transaction transaction);

/**
* Builds and returns a new {@code Transaction} based on form contents
* Builds and returns a new {@code Transaction} based on form contents.
*
* @return new {@code Transaction} instance
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import javafx.scene.layout.Pane;

/**
* Utility class to hold the controller, slip, and slip description
* Utility class to hold the controller, slip, and slip description.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@
package jgnash.uifx.views.register;

/**
* Panel type enumeration
* Panel type enumeration.
*
* @author Craig Cavanaugh
*/
public enum SlipType {
enum SlipType {
INCREASE, DECREASE
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import jgnash.util.NotNull;

/**
* Transaction Entry Controller for Split and Merges shares
* Transaction Entry Controller for Split and Merges shares.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import jgnash.util.ResourceUtils;

/**
* Split Transaction entry dialog
* Split Transaction entry dialog.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import jgnash.engine.TransactionEntry;

/**
* Split Transaction Entry Controller for Credits and Debits
* Split Transaction Entry Controller for Credits and Debits.
*
* @author Craig Cavanaugh
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,17 @@
import java.text.NumberFormat;

/**
* Table cell for Transaction amounts.
* <p>
* Applies a style to transaction amounts
*
* @author Craig Cavanaugh
*/
class TransactionCommodityFormatTableCell extends AbstractTransactionTableCell {

private final NumberFormat format;

public TransactionCommodityFormatTableCell(final NumberFormat format) {
TransactionCommodityFormatTableCell(final NumberFormat format) {
super();

this.format = format;
Expand Down
Loading

0 comments on commit ea17fc5

Please sign in to comment.