PartyInvoiceApp (Party Invoice 1.0.0 API)

java.lang.Object
- javafx.application.Application
- - com.illucit.partyinvoice.PartyInvoiceApp

public class PartyInvoiceApp
extends javafx.application.Application

Main Application class for Party Invoice.

Author:: Christian Simon

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PartyInvoiceApp.SelectedView
Enum for the selected right-side view in the main window.
- Nested classes/interfaces inherited from class javafx.application.Application
  javafx.application.Application.Parameters

Nested Classes
Modifier and Type	Class and Description
`static class`	`PartyInvoiceApp.SelectedView` Enum for the selected right-side view in the main window.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`VIEW_ABOUT` Vioew for the about dialog.
`static String`	`VIEW_INVOICES` Right-side view "Invoices".
`static String`	`VIEW_MAIN` View with the contents of the main window.
`static String`	`VIEW_MESSAGE` View for the message box.
`static String`	`VIEW_PERSONS` Right-side view "Persons".
`static String`	`VIEW_RESULT` Right-side view "Result".
`static String`	`VIEW_ROOT` Root view for main window (including menu).
`static String`	`VIEW_SAVECONFIRM` View for the "Save?"
`static String`	`VIEW_WELCOME` Right-side view "Welcome".

Fields inherited from class javafx.application.Application
STYLESHEET_CASPIAN, STYLESHEET_MODENA

Constructor Summary

Constructors
Constructor and Description

PartyInvoiceApp()

Constructors
Constructor and Description
`PartyInvoiceApp()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInvoice(String title, int paidBy)` Perform operation: add invoice.
`void`	`addItem(String title, long price, int quantity, Integer paidBy, Integer personToPay, Integer groupToPay)` Perform operation: add item to selected invoice.
`void`	`addPerson(String name)` Perform operation: add person.
`void`	`changeInvoice(int id, String newTitle, int paidBy)` Perform operation: change invoice.
`void`	`changeItem(int id, String title, long price, int quantity, Integer paidBy, Integer personToPay, Integer groupToPay)` Perform operation: change item.
`void`	`changeLocale(Locale locale)` Change locale and reload UI.
`void`	`changePerson(int id, String newName)` Perform operation: change person.
`void`	`deleteInvoice(int id)` Perform operation: delete invoice.
`void`	`deleteItem(int id)` Perform operation: delete item.
`void`	`deletePerson(int id)` Perform operation: delete person.
`void`	`followIllucitHyperlink()` Open the web browser and display the illucit.com website.
`javafx.collections.ObservableList<InvoiceModel>`	`getInvoiceList()` Get the observable list containing the invoice models of the current project.
`javafx.collections.ObservableList<ItemModel>`	`getItemList()` Get the observable list containing the item models of the currently selected invoice.
`javafx.collections.ObservableList<PersonModel>`	`getPersonList()` Get the observable list containing the persons of the current project.
`javafx.collections.ObservableList<PersonListModel>`	`getPersonNameList()` Get the observable list containing the person names of the current project.
`javafx.collections.ObservableList<PersonListModel>`	`getPersonNameListNullable()` Get the observable list containing the person names of the current project, include an empty entry which can be interpretet as null.
`javafx.stage.Stage`	`getPrimaryStage()` Returns the main stage.
`javafx.collections.ObservableList<ResultModel>`	`getResultList()` Get the observable list containing the result models of the current project.
`javafx.collections.ObservableList<ToPayModel>`	`getToPayList()` Get the observable list containing the "to pay" models of the current project: Everybody One model for each group One model for each person
`PartyInvoiceApp.SelectedView`	`getView()` Get the active right side view.
`void`	`init()` Initialize JavaFX application.
`boolean`	`isChanged()` Check if current project was changed since the last save.
`static void`	`main(String[] args)` Start program.
`void`	`menuLoadProject()` Perform Menu Operation "Load Project".
`void`	`menuNewProject()` Perform Menu Operation "New Project".
`void`	`performOperation(Operation operation)` Perform any abstract operation to the current project state and then reload the observable data.
`void`	`quit()` Quit program (and show "Save Confirmation" dialog is necessary).
`void`	`redo()` Forward project to the next redo step.
`boolean`	`saveAsProject()` Save project as new file.
`boolean`	`saveProject()` Save project.
`void`	`selectView(PartyInvoiceApp.SelectedView selectedView)` Select a view to be active.
`void`	`setSelectedInvoiceProperty(javafx.beans.property.ReadOnlyObjectProperty<InvoiceModel> selectedInvoiceProperty)` Set the object property binding for the currently selected invoice in the `PartyInvoiceApp.SelectedView.Invoices` view.
`void`	`showAboutDialog()` Show about dialog.
`void`	`start(javafx.stage.Stage primaryStage)` Start main window.
`void`	`undo()` Reset project to the latest undo step.

Methods inherited from class javafx.application.Application
getHostServices, getParameters, getUserAgentStylesheet, launch, launch, notifyPreloader, setUserAgentStylesheet, stop

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VIEW_ROOT
```
public static final String VIEW_ROOT
```
    Root view for main window (including menu).
    
    See Also:
    
    Constant Field Values
  - VIEW_MAIN
```
public static final String VIEW_MAIN
```
    View with the contents of the main window.
    
    See Also:
    
    Constant Field Values
  - VIEW_MESSAGE
```
public static final String VIEW_MESSAGE
```
    View for the message box.
    
    See Also:
    
    Constant Field Values
  - VIEW_SAVECONFIRM
```
public static final String VIEW_SAVECONFIRM
```
    View for the "Save?" confirmation dialog.
    
    See Also:
    
    Constant Field Values
  - VIEW_ABOUT
```
public static final String VIEW_ABOUT
```
    Vioew for the about dialog.
    
    See Also:
    
    Constant Field Values
  - VIEW_WELCOME
```
public static final String VIEW_WELCOME
```
    Right-side view "Welcome".
    
    See Also:
    
    Constant Field Values
  - VIEW_PERSONS
```
public static final String VIEW_PERSONS
```
    Right-side view "Persons".
    
    See Also:
    
    Constant Field Values
  - VIEW_INVOICES
```
public static final String VIEW_INVOICES
```
    Right-side view "Invoices".
    
    See Also:
    
    Constant Field Values
  - VIEW_RESULT
```
public static final String VIEW_RESULT
```
    Right-side view "Result".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PartyInvoiceApp
```
public PartyInvoiceApp()
```
- Method Detail
  - main
```
public static void main(String[] args)
```
    Start program.
    
    Parameters:
    
    args - parameters from commandline
  - init
```
public void init()
          throws Exception
```
    Initialize JavaFX application.
    
    Overrides:
    
    init in class javafx.application.Application
    
    Throws:
    
    Exception
  - start
```
public void start(javafx.stage.Stage primaryStage)
           throws Exception
```
    Start main window.
    
    Specified by:
    
    start in class javafx.application.Application
    
    Throws:
    
    Exception
  - changeLocale
```
public void changeLocale(Locale locale)
```
    Change locale and reload UI.
    
    Parameters:
    
    locale - target locale
  - selectView
```
public void selectView(PartyInvoiceApp.SelectedView selectedView)
```
    Select a view to be active.
    
    Parameters:
    
    selectedView - right side view that should be active
  - getView
```
public PartyInvoiceApp.SelectedView getView()
```
    Get the active right side view.
    
    Returns:
    
    active right side view
  - isChanged
```
public boolean isChanged()
```
    Check if current project was changed since the last save.
    
    Returns:
    
    save
  - getPrimaryStage
```
public javafx.stage.Stage getPrimaryStage()
```
    Returns the main stage.
    
    Returns:
    
    main stage
  - getPersonList
```
public javafx.collections.ObservableList<PersonModel> getPersonList()
```
    Get the observable list containing the persons of the current project.
    
    Returns:
    
    list of person models
  - getPersonNameList
```
public javafx.collections.ObservableList<PersonListModel> getPersonNameList()
```
    Get the observable list containing the person names of the current project.
    
    Returns:
    
    list of person names
  - getPersonNameListNullable
```
public javafx.collections.ObservableList<PersonListModel> getPersonNameListNullable()
```
    Get the observable list containing the person names of the current project, include an empty entry which can be interpretet as null.
    
    Returns:
    
    list of person names
  - getInvoiceList
```
public javafx.collections.ObservableList<InvoiceModel> getInvoiceList()
```
    Get the observable list containing the invoice models of the current project.
    
    Returns:
    
    list of invoice models
  - setSelectedInvoiceProperty
```
public void setSelectedInvoiceProperty(javafx.beans.property.ReadOnlyObjectProperty<InvoiceModel> selectedInvoiceProperty)
```
    Set the object property binding for the currently selected invoice in the PartyInvoiceApp.SelectedView.Invoices view. A change handler for the selected invoice is added to refresh the data for the item list belonging to current invoice.
    
    Parameters:
    
    selectedInvoiceProperty - property for the selected invoice
  - getItemList
```
public javafx.collections.ObservableList<ItemModel> getItemList()
```
    Get the observable list containing the item models of the currently selected invoice.
    
    Returns:
    
    list of item models
  - getToPayList
```
public javafx.collections.ObservableList<ToPayModel> getToPayList()
```
    Get the observable list containing the "to pay" models of the current project:
    - Everybody
    - One model for each group
    - One model for each person
    Returns:
    
    list of "to pay" models
  - getResultList
```
public javafx.collections.ObservableList<ResultModel> getResultList()
```
    Get the observable list containing the result models of the current project.
    
    Returns:
    
    list of result models
  - quit
```
public void quit()
```
    Quit program (and show "Save Confirmation" dialog is necessary).
  - showAboutDialog
```
public void showAboutDialog()
```
    Show about dialog.
  - followIllucitHyperlink
```
public void followIllucitHyperlink()
```
    Open the web browser and display the illucit.com website.
  - menuNewProject
```
public void menuNewProject()
```
    Perform Menu Operation "New Project".
  - menuLoadProject
```
public void menuLoadProject()
```
    Perform Menu Operation "Load Project".
  - saveProject
```
public boolean saveProject()
```
    Save project.
    
    Returns:
    
    true, if was successful
  - saveAsProject
```
public boolean saveAsProject()
```
    Save project as new file.
    
    Returns:
    
    true, if was successful
  - performOperation
```
public void performOperation(Operation operation)
```
    Perform any abstract operation to the current project state and then reload the observable data.
    
    Parameters:
    
    operation - operation to perform
  - undo
```
public void undo()
```
    Reset project to the latest undo step.
  - redo
```
public void redo()
```
    Forward project to the next redo step.
  - addPerson
```
public void addPerson(String name)
```
    Perform operation: add person.
    
    Parameters:
    
    name - new name
  - changePerson
```
public void changePerson(int id,
                         String newName)
```
    Perform operation: change person.
    
    Parameters:
    
    id - id of existing person
    
    newName - new name of person
  - deletePerson
```
public void deletePerson(int id)
```
    Perform operation: delete person.
    
    Parameters:
    
    id - id of existing person
  - addInvoice
```
public void addInvoice(String title,
                       int paidBy)
```
    Perform operation: add invoice.
    
    Parameters:
    
    title - title of new invoice
    
    paidBy - "paid by" person of new invoice
  - changeInvoice
```
public void changeInvoice(int id,
                          String newTitle,
                          int paidBy)
```
    Perform operation: change invoice.
    
    Parameters:
    
    id - id of existing invoice
    
    newTitle - new title of invoice
    
    paidBy - new "paid by" person of invoice
  - deleteInvoice
```
public void deleteInvoice(int id)
```
    Perform operation: delete invoice.
    
    Parameters:
    
    id - id of existing invoice
  - addItem
```
public void addItem(String title,
                    long price,
                    int quantity,
                    Integer paidBy,
                    Integer personToPay,
                    Integer groupToPay)
```
    Perform operation: add item to selected invoice.
    
    Parameters:
    
    title - title of new item
    
    price - price of new item
    
    quantity - quantity of new item
    
    paidBy - "paid by" person of new item
    
    personToPay - "person to pay" person of new item
    
    groupToPay - "group to pay" group of new item
  - changeItem
```
public void changeItem(int id,
                       String title,
                       long price,
                       int quantity,
                       Integer paidBy,
                       Integer personToPay,
                       Integer groupToPay)
```
    Perform operation: change item.
    
    Parameters:
    
    id - id of existing item
    
    title - new title of item
    
    price - new price of item
    
    quantity - new quantity of item
    
    paidBy - new "paid by" person of item
    
    personToPay - new "person to pay" person of item
    
    groupToPay - new "group to pay" group of item
  - deleteItem
```
public void deleteItem(int id)
```
    Perform operation: delete item.
    
    Parameters:
    
    id - id of existing item

Class PartyInvoiceApp

Nested Class Summary

Nested classes/interfaces inherited from class javafx.application.Application

Field Summary

Fields inherited from class javafx.application.Application

Constructor Summary

Method Summary

Methods inherited from class javafx.application.Application

Methods inherited from class java.lang.Object

Field Detail

VIEW_ROOT

VIEW_MAIN

VIEW_MESSAGE

VIEW_SAVECONFIRM

VIEW_ABOUT

VIEW_WELCOME

VIEW_PERSONS

VIEW_INVOICES

VIEW_RESULT

Constructor Detail

PartyInvoiceApp

Method Detail

main

init

start

changeLocale

selectView

getView

isChanged

getPrimaryStage

getPersonList

getPersonNameList

getPersonNameListNullable

getInvoiceList

setSelectedInvoiceProperty

getItemList

getToPayList

getResultList

quit

showAboutDialog

followIllucitHyperlink

menuNewProject

menuLoadProject

saveProject

saveAsProject

performOperation

undo

redo

addPerson

changePerson

deletePerson

addInvoice

changeInvoice

deleteInvoice

addItem

changeItem

deleteItem