easik.sketch.util.ini
Class IniSettings

java.lang.Object
  extended by easik.sketch.util.ini.IniSettings

public class IniSettings
extends java.lang.Object

A controller class that stores the values store in the ini file

Since:
2006-07-11 Kevin Green
Version:
2006-08-04 Kevin Green
Author:
Kevin Green 2006

Field Summary
private  IniFile _iFile
          The ini file associated with this sketch
private  java.awt.Color CONSTRAINT_BG_COLOR
          The color of the background of constraints
private  java.awt.Color CONSTRAINT_BORDER_COLOR
          The color of constraint borders
private  java.awt.Color CONSTRAINT_FG_COLOR
          The color of the foreground of constraints
private  java.awt.Color ENTITY_BG_COLOR
          The color of the background of entities
private  java.awt.Color ENTITY_BORDER_COLOR
          The color of the border of entities
private  java.awt.Color ENTITY_FG_COLOR
          The color of the foreground of entities
private  java.lang.String FILENAME
          The name of the ini file
private  java.awt.Color FLETCHED_EDGE_COLOR
          The color of a fletched edge
static int FOLDER_LAST_USED
          Option to use the last used folder as the default folder
static int FOLDER_RUNNING
          Option to use the program running directory as the default folder
static int FOLDER_SPECIFIC
          Option to use the specified
private  java.lang.String lastUsedFolder
          Last used folder
private  int numRecentFiles
          The number of most recent files, constrained to eight
private  java.awt.Color PATH_SELECTION_COLOR
          The path selection color
private  java.util.LinkedList<java.lang.String> RECENT_FILES
          The list of the most recent files used
private  int saveOpenOperation
          Default save/open folder operation
private  boolean showAllAttsAndUniqueKeys
          The default value for show all attributes & unique keys option when app is loaded
private  java.awt.Color SIMPLE_EDGE_COLOR
          The color of a simple edge
private  java.lang.String specificFolder
          Specific Folder
private  java.awt.Color STANDARD_SELECTION_COLOR
          The standard selection color
private  java.awt.Color VIRTUAL_EDGE_COLOR
          The color of a virtual edge
private  java.awt.Color VIRTUAL_HIGHLIGHTED_EDGE_COLOR
          The color of a virtual highlighted edge
 
Constructor Summary
IniSettings()
          Default constructor
 
Method Summary
 void addRecentFile(java.io.File inFile)
          Adds a file to the top of the recent file list
 java.lang.String colorToString(java.awt.Color inColor)
          Returns the standard web code for the given color
 java.awt.Color getCONSTRAINT_BG_COLOR()
           
 java.awt.Color getCONSTRAINT_BORDER_COLOR()
           
 java.awt.Color getCONSTRAINT_FG_COLOR()
           
 java.lang.String getDefaultFolder()
          Returns the default folder to be used for open and save operations based on the current settings
 java.awt.Color getENTITY_BG_COLOR()
           
 java.awt.Color getENTITY_BORDER_COLOR()
           
 java.awt.Color getENTITY_FG_COLOR()
           
 java.awt.Color getFLETCHED_EDGE_COLOR()
           
 java.lang.String getLastUsedFolder()
           
 java.awt.Color getPATH_SELECTION_COLOR()
           
 java.util.LinkedList<java.lang.String> getRECENT_FILES()
           
 int getSaveOpenOperation()
           
 java.awt.Color getSIMPLE_EDGE_COLOR()
           
 java.lang.String getSpecificFolder()
           
 java.awt.Color getSTANDARD_SELECTION_COLOR()
           
 java.awt.Color getVIRTUAL_EDGE_COLOR()
           
 java.awt.Color getVIRTUAL_HIGHLIGHTED_EDGE_COLOR()
           
 boolean isShowAllAttsAndUniqueKeys()
           
 void readBasicSettings()
          Reads the recent files from the initialization file
 void readRecentFiles()
          Reads the recent files from the initialization file
 void readUIColorSettings()
          Reads the UI Color Settings in from the initialization file
 void rewriteBasicSettings()
          Initializes the recent files list
 void rewriteRecentFiles()
          Initializes the recent files list
 void rewriteUIColorSettings()
          Rewrites the UI Color Settings to the initialization file
 void setCONSTRAINT_BG_COLOR(java.awt.Color constraint_bg_color)
           
 void setCONSTRAINT_BORDER_COLOR(java.awt.Color constraint_border_color)
           
 void setCONSTRAINT_FG_COLOR(java.awt.Color constraint_fg_color)
           
 void setENTITY_BG_COLOR(java.awt.Color entity_bg_color)
           
 void setENTITY_BORDER_COLOR(java.awt.Color entity_border_color)
           
 void setENTITY_FG_COLOR(java.awt.Color entity_fg_color)
           
 void setFLETCHED_EDGE_COLOR(java.awt.Color fletched_edge_color)
           
 void setLastUsedFolder(java.lang.String lastUsedFolder)
           
 void setPATH_SELECTION_COLOR(java.awt.Color selection_color)
           
 void setRECENT_FILES(java.util.LinkedList<java.lang.String> recent_files)
           
 void setSaveOpenOperation(int saveOpenOperation)
           
 void setShowAllAttsAndUniqueKeys(boolean showAllAttsAndUniqueKeys)
           
 void setSIMPLE_EDGE_COLOR(java.awt.Color simple_edge_color)
           
 void setSpecificFolder(java.lang.String specificFolder)
           
 void setSTANDARD_SELECTION_COLOR(java.awt.Color standard_selection_color)
           
 void setVIRTUAL_EDGE_COLOR(java.awt.Color virtual_edge_color)
           
 void setVIRTUAL_HIGHLIGHTED_EDGE_COLOR(java.awt.Color virtual_highlighted_edge_color)
           
 boolean writeToFile()
          Calls for the initialization file to be writte to disk
 void writeToIniBasicSettings()
          Writes the recent files to the IniFile
 void writeToIniColorSettings()
          Writes temporary UI Color Settings information to the IniFile
 void writeToIniRecentFiles()
          Writes the recent files to the IniFile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_iFile

private IniFile _iFile
The ini file associated with this sketch


FILENAME

private final java.lang.String FILENAME
The name of the ini file

See Also:
Constant Field Values

ENTITY_BORDER_COLOR

private java.awt.Color ENTITY_BORDER_COLOR
The color of the border of entities


ENTITY_BG_COLOR

private java.awt.Color ENTITY_BG_COLOR
The color of the background of entities


ENTITY_FG_COLOR

private java.awt.Color ENTITY_FG_COLOR
The color of the foreground of entities


CONSTRAINT_BORDER_COLOR

private java.awt.Color CONSTRAINT_BORDER_COLOR
The color of constraint borders


CONSTRAINT_BG_COLOR

private java.awt.Color CONSTRAINT_BG_COLOR
The color of the background of constraints


CONSTRAINT_FG_COLOR

private java.awt.Color CONSTRAINT_FG_COLOR
The color of the foreground of constraints


SIMPLE_EDGE_COLOR

private java.awt.Color SIMPLE_EDGE_COLOR
The color of a simple edge


FLETCHED_EDGE_COLOR

private java.awt.Color FLETCHED_EDGE_COLOR
The color of a fletched edge


VIRTUAL_EDGE_COLOR

private java.awt.Color VIRTUAL_EDGE_COLOR
The color of a virtual edge


VIRTUAL_HIGHLIGHTED_EDGE_COLOR

private java.awt.Color VIRTUAL_HIGHLIGHTED_EDGE_COLOR
The color of a virtual highlighted edge


PATH_SELECTION_COLOR

private java.awt.Color PATH_SELECTION_COLOR
The path selection color


STANDARD_SELECTION_COLOR

private java.awt.Color STANDARD_SELECTION_COLOR
The standard selection color


lastUsedFolder

private java.lang.String lastUsedFolder
Last used folder


specificFolder

private java.lang.String specificFolder
Specific Folder


FOLDER_LAST_USED

public static final int FOLDER_LAST_USED
Option to use the last used folder as the default folder

See Also:
Constant Field Values

FOLDER_RUNNING

public static final int FOLDER_RUNNING
Option to use the program running directory as the default folder

See Also:
Constant Field Values

FOLDER_SPECIFIC

public static final int FOLDER_SPECIFIC
Option to use the specified

See Also:
Constant Field Values

saveOpenOperation

private int saveOpenOperation
Default save/open folder operation


showAllAttsAndUniqueKeys

private boolean showAllAttsAndUniqueKeys
The default value for show all attributes & unique keys option when app is loaded


RECENT_FILES

private java.util.LinkedList<java.lang.String> RECENT_FILES
The list of the most recent files used


numRecentFiles

private int numRecentFiles
The number of most recent files, constrained to eight

Constructor Detail

IniSettings

public IniSettings()
Default constructor

Method Detail

writeToFile

public boolean writeToFile()
Calls for the initialization file to be writte to disk

Returns:
True if it suceed in writing, false otherwise

getCONSTRAINT_BG_COLOR

public java.awt.Color getCONSTRAINT_BG_COLOR()
Returns:
Returns the cONSTRAINT_BG_COLOR.

setCONSTRAINT_BG_COLOR

public void setCONSTRAINT_BG_COLOR(java.awt.Color constraint_bg_color)
Parameters:
constraint_bg_color - The cONSTRAINT_BG_COLOR to set.

getCONSTRAINT_BORDER_COLOR

public java.awt.Color getCONSTRAINT_BORDER_COLOR()
Returns:
Returns the cONSTRAINT_BORDER_COLOR.

setCONSTRAINT_BORDER_COLOR

public void setCONSTRAINT_BORDER_COLOR(java.awt.Color constraint_border_color)
Parameters:
constraint_border_color - The cONSTRAINT_BORDER_COLOR to set.

getCONSTRAINT_FG_COLOR

public java.awt.Color getCONSTRAINT_FG_COLOR()
Returns:
Returns the cONSTRAINT_FG_COLOR.

setCONSTRAINT_FG_COLOR

public void setCONSTRAINT_FG_COLOR(java.awt.Color constraint_fg_color)
Parameters:
constraint_fg_color - The cONSTRAINT_FG_COLOR to set.

getENTITY_BG_COLOR

public java.awt.Color getENTITY_BG_COLOR()
Returns:
Returns the eNTITY_BG_COLOR.

setENTITY_BG_COLOR

public void setENTITY_BG_COLOR(java.awt.Color entity_bg_color)
Parameters:
entity_bg_color - The eNTITY_BG_COLOR to set.

getENTITY_BORDER_COLOR

public java.awt.Color getENTITY_BORDER_COLOR()
Returns:
Returns the eNTITY_BORDER_COLOR.

setENTITY_BORDER_COLOR

public void setENTITY_BORDER_COLOR(java.awt.Color entity_border_color)
Parameters:
entity_border_color - The eNTITY_BORDER_COLOR to set.

getENTITY_FG_COLOR

public java.awt.Color getENTITY_FG_COLOR()
Returns:
Returns the eNTITY_FG_COLOR.

setENTITY_FG_COLOR

public void setENTITY_FG_COLOR(java.awt.Color entity_fg_color)
Parameters:
entity_fg_color - The eNTITY_FG_COLOR to set.

getFLETCHED_EDGE_COLOR

public java.awt.Color getFLETCHED_EDGE_COLOR()
Returns:
Returns the fLETCHED_EDGE_COLOR.

setFLETCHED_EDGE_COLOR

public void setFLETCHED_EDGE_COLOR(java.awt.Color fletched_edge_color)
Parameters:
fletched_edge_color - The fLETCHED_EDGE_COLOR to set.

getPATH_SELECTION_COLOR

public java.awt.Color getPATH_SELECTION_COLOR()
Returns:
Returns the pATh_SELECTION_COLOR.

setPATH_SELECTION_COLOR

public void setPATH_SELECTION_COLOR(java.awt.Color selection_color)
Parameters:
selection_color - The pATH_SELECTION_COLOR to set.

getSTANDARD_SELECTION_COLOR

public java.awt.Color getSTANDARD_SELECTION_COLOR()
Returns:
Returns the sTANDARD_SELECTION_COLOR.

setSTANDARD_SELECTION_COLOR

public void setSTANDARD_SELECTION_COLOR(java.awt.Color standard_selection_color)
Parameters:
standard_selection_color - The sTANDARD_SELECTION_COLOR to set.

getSIMPLE_EDGE_COLOR

public java.awt.Color getSIMPLE_EDGE_COLOR()
Returns:
Returns the sIMPLE_EDGE_COLOR.

setSIMPLE_EDGE_COLOR

public void setSIMPLE_EDGE_COLOR(java.awt.Color simple_edge_color)
Parameters:
simple_edge_color - The sIMPLE_EDGE_COLOR to set.

getVIRTUAL_EDGE_COLOR

public java.awt.Color getVIRTUAL_EDGE_COLOR()
Returns:
Returns the vIRTUAL_EDGE_COLOR.

setVIRTUAL_EDGE_COLOR

public void setVIRTUAL_EDGE_COLOR(java.awt.Color virtual_edge_color)
Parameters:
virtual_edge_color - The vIRTUAL_EDGE_COLOR to set.

getVIRTUAL_HIGHLIGHTED_EDGE_COLOR

public java.awt.Color getVIRTUAL_HIGHLIGHTED_EDGE_COLOR()
Returns:
Returns the vIRTUAL_HIGHLIGHTED_EDGE_COLOR.

setVIRTUAL_HIGHLIGHTED_EDGE_COLOR

public void setVIRTUAL_HIGHLIGHTED_EDGE_COLOR(java.awt.Color virtual_highlighted_edge_color)
Parameters:
virtual_highlighted_edge_color - The vIRTUAL_HIGHLIGHTED_EDGE_COLOR to set.

readUIColorSettings

public void readUIColorSettings()
Reads the UI Color Settings in from the initialization file


colorToString

public java.lang.String colorToString(java.awt.Color inColor)
Returns the standard web code for the given color

Parameters:
inColor - The color to be converted
Returns:
The standard web color representation

rewriteUIColorSettings

public void rewriteUIColorSettings()
Rewrites the UI Color Settings to the initialization file


writeToIniColorSettings

public void writeToIniColorSettings()
Writes temporary UI Color Settings information to the IniFile


getLastUsedFolder

public java.lang.String getLastUsedFolder()
Returns:
Returns the lastUsedFolder.

setLastUsedFolder

public void setLastUsedFolder(java.lang.String lastUsedFolder)
Parameters:
lastUsedFolder - The lastUsedFolder to set.

getSaveOpenOperation

public int getSaveOpenOperation()
Returns:
Returns the saveOpenOperation.

setSaveOpenOperation

public void setSaveOpenOperation(int saveOpenOperation)
Parameters:
saveOpenOperation - The saveOpenOperation to set.

isShowAllAttsAndUniqueKeys

public boolean isShowAllAttsAndUniqueKeys()
Returns:
Returns the showAllAttsAndUniqueKeys.

setShowAllAttsAndUniqueKeys

public void setShowAllAttsAndUniqueKeys(boolean showAllAttsAndUniqueKeys)
Parameters:
showAllAttsAndUniqueKeys - The showAllAttsAndUniqueKeys to set.

getSpecificFolder

public java.lang.String getSpecificFolder()
Returns:
Returns the specificFolder.

setSpecificFolder

public void setSpecificFolder(java.lang.String specificFolder)
Parameters:
specificFolder - The specificFolder to set.

getDefaultFolder

public java.lang.String getDefaultFolder()
Returns the default folder to be used for open and save operations based on the current settings

Returns:
The default folder to be used for open and save operations

readBasicSettings

public void readBasicSettings()
Reads the recent files from the initialization file


rewriteBasicSettings

public void rewriteBasicSettings()
Initializes the recent files list


writeToIniBasicSettings

public void writeToIniBasicSettings()
Writes the recent files to the IniFile


getRECENT_FILES

public java.util.LinkedList<java.lang.String> getRECENT_FILES()
Returns:
Returns the rECENT_FILES.

setRECENT_FILES

public void setRECENT_FILES(java.util.LinkedList<java.lang.String> recent_files)
Parameters:
recent_files - The rECENT_FILES to set.

addRecentFile

public void addRecentFile(java.io.File inFile)
Adds a file to the top of the recent file list

Parameters:
inFile - The file to be added

readRecentFiles

public void readRecentFiles()
Reads the recent files from the initialization file


rewriteRecentFiles

public void rewriteRecentFiles()
Initializes the recent files list


writeToIniRecentFiles

public void writeToIniRecentFiles()
Writes the recent files to the IniFile