mirror of
https://github.com/robertvokac/time-calc.git
synced 2025-03-25 07:27:49 +01:00
Updated screenshot
This commit is contained in:
Robert Vokac
parent
488dda556a
commit
c244abe78b
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 51 KiB |
@ -1,165 +1,165 @@
|
|||||||
# Time Calc
|
# Time Calc
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Time Calc is a desktop application used to track the remaining time until the end of some activity - like working hours.
|
Time Calc is a desktop application used to track the remaining time until the end of some activity - like working hours.
|
||||||
|
|
||||||
_Time Calc is written in Java programming language and uses the Swing framework._
|
_Time Calc is written in Java programming language and uses the Swing framework._
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Start of application
|
### Start of application
|
||||||
|
|
||||||
When "Time Calc" is started", user is asked for:
|
When "Time Calc" is started", user is asked for:
|
||||||
- start time ... like 7:30
|
- start time ... like 7:30
|
||||||
- overtime ... like 0:45 ... overtime is optional and the default value is 0:00
|
- overtime ... like 0:45 ... overtime is optional and the default value is 0:00
|
||||||
|
|
||||||
### Restart of application
|
### Restart of application
|
||||||
|
|
||||||
You can restart the app, if you press the **"Restart"** button.
|
You can restart the app, if you press the **"Restart"** button.
|
||||||
- Then you are asked again for start time and overtime.
|
- Then you are asked again for start time and overtime.
|
||||||
|
|
||||||
### End of application
|
### End of application
|
||||||
|
|
||||||
You can stop the app, if you press the **"Exit"** button or click on the exit window button.
|
You can stop the app, if you press the **"Exit"** button or click on the exit window button.
|
||||||
- Then application is stopped.
|
- Then application is stopped.
|
||||||
|
|
||||||
|
|
||||||
## Special files
|
## Special files
|
||||||
|
|
||||||
If these files are present, something special happens.
|
If these files are present, something special happens.
|
||||||
|
|
||||||
### starttime.txt
|
### starttime.txt
|
||||||
|
|
||||||
This file contains the default start time - used during the previous run of the app.
|
This file contains the default start time - used during the previous run of the app.
|
||||||
If file starttime.txt does not exist, then the default start time is 7:00.
|
If file starttime.txt does not exist, then the default start time is 7:00.
|
||||||
|
|
||||||
### overtime.txt
|
### overtime.txt
|
||||||
|
|
||||||
This file contains the default overtime - used during the previous run of the app.
|
This file contains the default overtime - used during the previous run of the app.
|
||||||
If file overtime.txt does not exist, then the default overtime is 0:00.
|
If file overtime.txt does not exist, then the default overtime is 0:00.
|
||||||
|
|
||||||
### test.txt
|
### test.txt
|
||||||
If file test.txt exists, then user is not asked for start time and overtime. Instead, the values in files starttime.txt and overtime.txt are used.
|
If file test.txt exists, then user is not asked for start time and overtime. Instead, the values in files starttime.txt and overtime.txt are used.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
### 3 Visibility modes
|
### 3 Visibility modes
|
||||||
|
|
||||||
* STRONGLY_COLORED - many colors
|
* STRONGLY_COLORED - many colors
|
||||||
* WEAKLY_COLORED - darkened colors
|
* WEAKLY_COLORED - darkened colors
|
||||||
* GRAY - gray colors
|
* GRAY - gray colors
|
||||||
* NONE - widgets are hidden
|
* NONE - widgets are hidden
|
||||||
|
|
||||||
### Widgets
|
### Widgets
|
||||||
|
|
||||||
*
|
*
|
||||||
#### Analog Clock
|
#### Analog Clock
|
||||||
|
|
||||||
* hour hand
|
* hour hand
|
||||||
* minute hand (can be disabled in configuration)
|
* minute hand (can be disabled in configuration)
|
||||||
* second hand (can be disabled in configuration)
|
* second hand (can be disabled in configuration)
|
||||||
* millisecond hand (can be disabled in configuration)
|
* millisecond hand (can be disabled in configuration)
|
||||||
* shows current year, month, day of month and day of week, if analog clock is hovered by mouse cursor and Visibility is STRONGLY_COLORED
|
* shows current year, month, day of month and day of week, if analog clock is hovered by mouse cursor and Visibility is STRONGLY_COLORED
|
||||||
* shows yellow highlighted remaining time until end of today working hours, if analog clock is hovered by mouse cursor and Visibility is STRONGLY_COLORED
|
* shows yellow highlighted remaining time until end of today working hours, if analog clock is hovered by mouse cursor and Visibility is STRONGLY_COLORED
|
||||||
* hands can be long or shorter (can be set in configuration)
|
* hands can be long or shorter (can be set in configuration)
|
||||||
|
|
||||||
#### Progress Square
|
#### Progress Square
|
||||||
* Show graphically day progress
|
* Show graphically day progress
|
||||||
|
|
||||||
#### Progress Circle
|
#### Progress Circle
|
||||||
|
|
||||||
* Show graphically day progress
|
* Show graphically day progress
|
||||||
|
|
||||||
#### Hour Battery
|
#### Hour Battery
|
||||||
|
|
||||||
#### Day Battery
|
#### Day Battery
|
||||||
|
|
||||||
#### Week Battery
|
#### Week Battery
|
||||||
|
|
||||||
#### Month Battery
|
#### Month Battery
|
||||||
|
|
||||||
### Smileys
|
### Smileys
|
||||||
|
|
||||||
Progress in square, circle or batteries is represented also by smileys (only, if the widget is hovered by mouse cursor):
|
Progress in square, circle or batteries is represented also by smileys (only, if the widget is hovered by mouse cursor):
|
||||||
|
|
||||||
Smileys can be colored or white-black (can be set in configuration)
|
Smileys can be colored or white-black (can be set in configuration)
|
||||||
|
|
||||||
<pre>😱</pre> ... face screaming in fear ... less than 6.25%
|
<pre>😱</pre> ... face screaming in fear ... less than 6.25%
|
||||||
|
|
||||||
<pre>😡</pre> ... pouting face ... less than 12.5%
|
<pre>😡</pre> ... pouting face ... less than 12.5%
|
||||||
|
|
||||||
<pre>😠</pre> ... angry face ... less than 18.75%
|
<pre>😠</pre> ... angry face ... less than 18.75%
|
||||||
|
|
||||||
<pre>😭</pre> ... loudly crying face ... less than 25%
|
<pre>😭</pre> ... loudly crying face ... less than 25%
|
||||||
|
|
||||||
<pre>😢</pre> ... crying face ... less than 31.25%
|
<pre>😢</pre> ... crying face ... less than 31.25%
|
||||||
|
|
||||||
<pre>😞</pre> ... disappointed face ... less than 37.5%
|
<pre>😞</pre> ... disappointed face ... less than 37.5%
|
||||||
|
|
||||||
<pre>😫</pre> ... tired face ... less than 43.75%
|
<pre>😫</pre> ... tired face ... less than 43.75%
|
||||||
|
|
||||||
<pre>😨</pre> ... fearful face ... less than 50%
|
<pre>😨</pre> ... fearful face ... less than 50%
|
||||||
|
|
||||||
<pre>😲</pre> ... astonished face ... less than 56.25%
|
<pre>😲</pre> ... astonished face ... less than 56.25%
|
||||||
|
|
||||||
<pre>😦</pre> ... frowning face with open mouth ... less than 62.5%
|
<pre>😦</pre> ... frowning face with open mouth ... less than 62.5%
|
||||||
|
|
||||||
<pre>😊</pre> ... smiling face with smiling eyes ... less than 68.75%
|
<pre>😊</pre> ... smiling face with smiling eyes ... less than 68.75%
|
||||||
|
|
||||||
<pre>😃</pre> ... smiling face with open mouth ... less than 75%
|
<pre>😃</pre> ... smiling face with open mouth ... less than 75%
|
||||||
|
|
||||||
<pre>😁</pre> ... grinning face with smiling eyes ... less than 81.25%
|
<pre>😁</pre> ... grinning face with smiling eyes ... less than 81.25%
|
||||||
|
|
||||||
<pre>😎</pre> ... smiling face with sunglasses ... less than 87.5%
|
<pre>😎</pre> ... smiling face with sunglasses ... less than 87.5%
|
||||||
|
|
||||||
<pre>😍</pre> ... smiling face with heart-shaped eyes ... less than 93.75%
|
<pre>😍</pre> ... smiling face with heart-shaped eyes ... less than 93.75%
|
||||||
|
|
||||||
<pre>😈</pre> ... smiling face with horns ... more or equal to 93.75%
|
<pre>😈</pre> ... smiling face with horns ... more or equal to 93.75%
|
||||||
|
|
||||||
## Key shortcuts
|
## Key shortcuts
|
||||||
|
|
||||||
* UP - Show widgets again, if they were hidden
|
* UP - Show widgets again, if they were hidden
|
||||||
* DOWN - Hide all widgets and buttons
|
* DOWN - Hide all widgets and buttons
|
||||||
* H - Show all hide everything
|
* H - Show all hide everything
|
||||||
* G - switch between coloured and no-coloured visibility mode
|
* G - switch between coloured and no-coloured visibility mode
|
||||||
* C - switch between strongly coloured and weakly coloured visibility mode
|
* C - switch between strongly coloured and weakly coloured visibility mode
|
||||||
* V - switch visibility mode NONE and STRONGLY_COLOURED
|
* V - switch visibility mode NONE and STRONGLY_COLOURED
|
||||||
* SPACE - switch visibility mode: NONE, GREY, WEAKLY_COLOURED, STRONGLY_COLOURED
|
* SPACE - switch visibility mode: NONE, GREY, WEAKLY_COLOURED, STRONGLY_COLOURED
|
||||||
* F2 - run commands
|
* F2 - run commands
|
||||||
* R - restart app
|
* R - restart app
|
||||||
* T - enable or disable notifications
|
* T - enable or disable notifications
|
||||||
* W - open work days window
|
* W - open work days window
|
||||||
* A - open activity window
|
* A - open activity window
|
||||||
* S - open config window
|
* S - open config window
|
||||||
* P or F1 - open help window
|
* P or F1 - open help window
|
||||||
* X - exit application
|
* X - exit application
|
||||||
* J - show random Joke
|
* J - show random Joke
|
||||||
|
|
||||||
## Command button
|
## Command button
|
||||||
|
|
||||||
## Todos
|
## Todos
|
||||||
|
|
||||||
* Config window
|
* Config window
|
||||||
* Split to Maven modules
|
* Split to Maven modules
|
||||||
* Junit, Mockito, etc.
|
* Junit, Mockito, etc.
|
||||||
* Checkstyle
|
* Checkstyle
|
||||||
* Sonarlint
|
* Sonarlint
|
||||||
* Sonarqube
|
* Sonarqube
|
||||||
* Add SQLite support and store times of arrivals and departures and time of activities
|
* Add SQLite support and store times of arrivals and departures and time of activities
|
||||||
|
|
||||||
## For Developers
|
## For Developers
|
||||||
|
|
||||||
### How to add new property
|
### How to add new property
|
||||||
|
|
||||||
**Change these places:**
|
**Change these places:**
|
||||||
|
|
||||||
* timecalc-default.conf
|
* timecalc-default.conf
|
||||||
* TimeCalcProperty
|
* TimeCalcProperty
|
||||||
* TimeCalcConfiguration
|
* TimeCalcConfiguration
|
||||||
* ConfigWindow
|
* ConfigWindow
|
||||||
* Widget class
|
* Widget class
|
||||||
* MainWindow - bind
|
* MainWindow - bind
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Loading…
x
Reference in New Issue
Block a user