Package org.openscience.jmol.app
Class HistoryFile
- java.lang.Object
-
- org.openscience.jmol.app.HistoryFile
-
public class HistoryFile extends Object
The history file contains data from previous uses of Jmol.- Author:
- Bradley A. Smith (bradley@baysmith.com)
-
-
Field Summary
Fields Modifier and Type Field Description (package private) File
file
The location of the history file.(package private) String
header
The information written to the header of the history file.private Properties
properties
The data stored in the history file.
-
Constructor Summary
Constructors Constructor Description HistoryFile(File file, String header)
Creates a history file.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addProperties(Properties properties)
Adds the given properties to the history.boolean
addProperty(String key, String value)
Adds the given property to the history.private boolean
addWindowBorder(String name, Point border)
Adds the window border to the history.private boolean
addWindowDim(String name, Dimension d)
void
addWindowInfo(String name, Component window, Point border)
Adds the window informations to the history.void
addWindowInfo(String name, Component window, Point border, Dimension d)
void
addWindowInnerInfo(String name, Component window, Dimension inner)
private boolean
addWindowPosition(String name, Point position)
Adds the window position to the history.private boolean
addWindowSize(String name, Dimension size)
Adds the window size to the history.private boolean
addWindowVisibility(String name, boolean visible)
Adds the window visibility to the history.void
clear()
File
getFile()
Properties
getProperties()
String
getProperty(String key, String defaultValue)
Get the value of a propertyPoint
getWindowBorder(String name)
Dimension
getWindowInnerDimension(String name)
Point
getWindowPosition(String name)
Dimension
getWindowSize(String name)
private Boolean
getWindowVisibility(String name)
private void
load()
Loads properties from the history file.void
repositionWindow(String name, Component window)
Uses the informations in the history to reposition the window.void
repositionWindow(String name, Component window, int minWidth, int minHeight, boolean allowVisible)
Uses the informations in the history to reposition the window.void
save()
Saves properties to the history file.
-
-
-
Field Detail
-
properties
private Properties properties
The data stored in the history file.
-
file
File file
The location of the history file.
-
header
String header
The information written to the header of the history file.
-
-
Method Detail
-
addProperties
public void addProperties(Properties properties)
Adds the given properties to the history. If a property existed previously, it will be replaced.- Parameters:
properties
- the properties to add.
-
getProperties
public Properties getProperties()
- Returns:
- The properties stored in the history file.
-
getProperty
public String getProperty(String key, String defaultValue)
Get the value of a property- Parameters:
key
- Key of the property to finddefaultValue
- Default value to use if the property is not found- Returns:
- The value of the property
-
addProperty
public boolean addProperty(String key, String value)
Adds the given property to the history. If it existed previously, it will be replaced.- Parameters:
key
- Key of the property to addvalue
- Value of the property- Returns:
- true if the property is modified
-
getWindowPosition
public Point getWindowPosition(String name)
- Parameters:
name
- Window name- Returns:
- Position of the window stored in the history file
-
getWindowInnerDimension
public Dimension getWindowInnerDimension(String name)
- Parameters:
name
- Window name- Returns:
- Inner dimension of the window stored in the history file
-
getWindowBorder
public Point getWindowBorder(String name)
- Parameters:
name
- window name- Returns:
- window border stored in the history file
-
getWindowSize
public Dimension getWindowSize(String name)
- Parameters:
name
- Window name- Returns:
- Size of the window stored in the history file
-
getWindowVisibility
private Boolean getWindowVisibility(String name)
- Parameters:
name
- Window name- Returns:
- Visibility of the window stored in the history file
-
addWindowPosition
private boolean addWindowPosition(String name, Point position)
Adds the window position to the history. If it existed previously, it will be replaced.- Parameters:
name
- Window nameposition
- Window position- Returns:
- Tells if the properties are modified
-
addWindowBorder
private boolean addWindowBorder(String name, Point border)
Adds the window border to the history. If it existed previously, it will be replaced.- Parameters:
name
- window nameborder
- Window border- Returns:
- Tells if the properties are modified
-
addWindowSize
private boolean addWindowSize(String name, Dimension size)
Adds the window size to the history. If it existed previously, it will be replaced.- Parameters:
name
- Window namesize
- Window size- Returns:
- Tells if the properties are modified
-
addWindowVisibility
private boolean addWindowVisibility(String name, boolean visible)
Adds the window visibility to the history. If it existed previously, it will be replaced.- Parameters:
name
- Window namevisible
- Window visibilite- Returns:
- Tells if the properties are modified
-
addWindowInfo
public void addWindowInfo(String name, Component window, Point border)
Adds the window informations to the history. If it existed previously, it will be replaced.- Parameters:
name
- Window namewindow
- Windowborder
- Point border
-
repositionWindow
public void repositionWindow(String name, Component window, int minWidth, int minHeight, boolean allowVisible)
Uses the informations in the history to reposition the window.- Parameters:
name
- Window namewindow
- WindowminWidth
-minHeight
-allowVisible
- TODO
-
repositionWindow
public void repositionWindow(String name, Component window)
Uses the informations in the history to reposition the window.- Parameters:
name
- Window namewindow
- Window
-
getFile
public File getFile()
-
load
private void load()
Loads properties from the history file.
-
save
public void save()
Saves properties to the history file.
-
clear
public void clear()
-
-