Venice 0.751beta

nz.org.venice.analyser
Class PortfolioPage

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPanel
                  extended bynz.org.venice.analyser.Page
                      extended bynz.org.venice.analyser.PortfolioPage
All Implemented Interfaces:
javax.accessibility.Accessible, AnalyserPage, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class PortfolioPage
extends Page
implements AnalyserPage

An analysis tool page that lets the user enter basic portfolio information. This page is used by both the PaperTradeModule and GPModule. The page contains the following user fields:

The initial capital field describes the initial amount of money that is available for trading in the portfolio. The trade cost field determines the cost for accumulating or reducing a stock holding. The last two fields describe whether the portfolio has a fixed maximum number of stocks, or has a variable number of stocks depending on the current value of the portfolio.

Author:
Andrew Leppard
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int NUMBER_STOCKS_MODE
          Portfolio has a fixed maximum number of stocks.
static int STOCK_VALUE_MODE
          Portfolio has a variable number of stocks depending on the value of the portfolio.
 
Fields inherited from class nz.org.venice.analyser.Page
desktop
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
PortfolioPage(javax.swing.JDesktopPane desktop)
          Construct a new portfolio page.
 
Method Summary
 javax.swing.JComponent getComponent()
          Return the page's graphical user interface.
 Money getInitialCapital()
          Return the portfolio's initial capital.
 int getMode()
          Return whether the maximum number of stocks in the portfolio is fixed or variable depending on the value of the portfolio.
 int getNumberStocks()
          Return the maximum number of stocks in the portfolio.
 Money getStockValue()
          Return the fixed value of each stock in the portfolio.
 java.lang.String getTitle()
          Return the title of this page.
 Money getTradeCost()
          Return the cost of an accumulate or reduce trade.
 void load(java.lang.String key)
          Load the user interface values from preferences.
 boolean parse()
          Parse the values the user has entered into the GUI.
 void save(java.lang.String key)
          Save the user interface values to preferences.
 
Methods inherited from class nz.org.venice.analyser.Page
showErrorMessage
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NUMBER_STOCKS_MODE

public static final int NUMBER_STOCKS_MODE
Portfolio has a fixed maximum number of stocks.

See Also:
Constant Field Values

STOCK_VALUE_MODE

public static final int STOCK_VALUE_MODE
Portfolio has a variable number of stocks depending on the value of the portfolio.

See Also:
Constant Field Values
Constructor Detail

PortfolioPage

public PortfolioPage(javax.swing.JDesktopPane desktop)
Construct a new portfolio page.

Parameters:
desktop - the desktop
Method Detail

load

public void load(java.lang.String key)
Description copied from interface: AnalyserPage
Load the user interface values from preferences.

Specified by:
load in interface AnalyserPage
Parameters:
key - a key which uniquely identifies the analysis tool using this page

save

public void save(java.lang.String key)
Description copied from interface: AnalyserPage
Save the user interface values to preferences.

Specified by:
save in interface AnalyserPage
Parameters:
key - a key which uniquely identifies the analysis tool using this page

parse

public boolean parse()
Description copied from interface: AnalyserPage
Parse the values the user has entered into the GUI. If any of the values are invalid, the page will display an option pane describing the error, and the function will return false.

Specified by:
parse in interface AnalyserPage
Returns:
true if the user's values are valid, false otherwise.

getComponent

public javax.swing.JComponent getComponent()
Description copied from interface: AnalyserPage
Return the page's graphical user interface.

Specified by:
getComponent in interface AnalyserPage
Returns:
the GUI

getTitle

public java.lang.String getTitle()
Description copied from interface: AnalyserPage
Return the title of this page.

Specified by:
getTitle in interface AnalyserPage
Returns:
the page's title

getInitialCapital

public Money getInitialCapital()
Return the portfolio's initial capital.

Returns:
the initial capital

getTradeCost

public Money getTradeCost()
Return the cost of an accumulate or reduce trade.

Returns:
the trade cost

getMode

public int getMode()
Return whether the maximum number of stocks in the portfolio is fixed or variable depending on the value of the portfolio.

Returns:
NUMBER_STOCKS_MODE or STOCK_VALUE_MODE

getStockValue

public Money getStockValue()
Return the fixed value of each stock in the portfolio. Only call this function if the portfolio is in STOCK_VALUE_MODE.

Returns:
the stock value

getNumberStocks

public int getNumberStocks()
Return the maximum number of stocks in the portfolio. Only call this function if the portfolio is in NUMBER_STOCKS_MODE.

Returns:
the maximum number of stocks

Venice 0.751beta