MyBox: Easy Tools Set

User Guide - Overview

Author: Mara

Version: 6.8

Date: 2024-2-9

1 Introduction

This is desktop application based on JavaFx to provide simple and easy functions. It's free and open sources.

1.1 What's New

2024-2-9 v6.8

• Improve:

  • New shortcut CTRL/ALT+0: set/disable “Always on top”. Not work for popup window.

  • New shortcut CTRL/ALT+9: Snapshot current window.

  • Save and manage “Image Scope” in tree.

  • Simplify interface of editing html.

• Solved problems:

  • Manage colors: “Copy colors” fails to work.

  • Edit html: Contents are lost when switch from “texts” mode.

  • Button “play” does not work in interface of “View PPT”.

Happy Chinese Loong Year!

Closed requirements/bugs in this version

1.2 Notice

Without enough testings, MyBox has low reliability and bad stability. When use MyBox, following may happen:

• Files/Data are damaged.

• Output wrong results.

• Functions fail.

• Other unexpected behaviours.

1.3 Cross Platforms

MyBox is implemented in pure Java and only based on open sources, and it can run on platforms which support Java 21.
Versions before v5.3 are based on Java 8.

1.4 Internationalized

1. All codes of MyBox are internationalized. Language can be switched in time.

2. Each langauge is defined in one resource files, like: "Messages_NAME.properties".

3. Support adding new languages online. Table is provided with English as comparison. New langauges take effects at once.
   Example, the new language is named as "aa", and its resource files are Messages_aa.properties.

4. Translated languages can be shared with others: Put the files under "mybox_languages" of data path and MyBox is aware of them immediately.

5. Embed Chinese and English, whose files are under path MyBox/src/main/resources/bundles/.

Language	Resource file of interface
Chinese	Messages_zh_CN.properties
English	Messages_en.properties

1.5 Personal

1. All functions are executed in local host.

2. All data are saved in local host.

3. No register/login/DataCenter/Cloud.

4. Access network only when user requests.

5. Only read/write data which user need.

1.6 Friendly

1. Provide tips of current function/interface.

2. Remember user’s inputs or selections, and provide histories list.

3. Interfaces can be adjusted and some panes can be hidden.

4. Behaviours of some controls can be chosen.

5. Provide context menu and function menu to texts/image/html/table/tree.

6. Current texts/image/html/data can be popped.

7. Clipboards of texts/image/data can be managed.

8. Provide examples and useful information.

9. Appearance of interface and controls can be chosen and modified.

1.7 Data Compatible

1. Exported data are in common text formats, like txt/csv/xml/json/html.

2. Imported data are in common text format, like txt/csv.

3. At least one exported format can be imported.

4. Imported data are self-contain, that original data can be rebuilt without extra data.

1.8 Embedded Database System

1. Derby is free and open sources:

   • When start MyBox for the first time, some seconds are cost to create internal database tables and write initial data.

   • All database files are under data path, so different target data sets can be handled by switching data paths.

   • Multiple MyBox instances can share data by visiting same data path.

   • When database files not found under data path(damaged or deleted unexpectedly), MyBox can create database automatically.

2. Derby runs in embedded mode by default:

   • External processes can not access the database.

   • Only one MyBox instance can use the database at the same time.

3. Derby can run in network mode:

   • The first visitor becomes the server.

   • Processes of local host can visit the database in port 1527 and becomes its clients.

   • Processes out of local host can not visit the database directly.

4. MyBox internal tables save the data required by all functions. User can access and modify the internal data online.

5. User can define customized database tables.

6. User can view and edit definitons and data of database tables in paginated tables, and execute SQL statements.

7. To implement data sorting, tranposing, statistic, and grouping, MyBox will create temporary database tables, and clear them in time.

1.9 Assit Coding Self

1. Monitor memory/CPU usage in real time.

2. Adjust logging online.

3. Generate icons automatically.

4. Edit and apply languages online.

5. Test automatically.

6. All kinds of documents.
   
   

2 Resources Addresses

3 Documents

4 Download and Execution

4.1 Source Codes

Source Codes	Size	Developement Guide	Packing Steps
MyBox-src.zip	73M-	pdf	html

4.2 Self-contain packages

Self-contain packages include all files and need not java env nor installation.

User can double click the launcher to start MyBox or run it by command line. The default "Open Method" of image/text/PDF files can be associated to MyBox and a file can be opened directly by MyBox by double clicking the file’s name.

4.3 Jar

When JRE or JDK(Oracle jdk or open jdk) is installed, jar can run:

Run following command to launch this program with Jar package:

     java   -jar   MyBox.jar

A file path can follow the command as argument to be opened directly by MyBox. Example, following command will open the image:

     java   -jar   MyBox.jar   /tmp/a1.jpg

4.4 Versions

Contents of this document may be expired, but its links refer to the latest versions.

The latest versions and all archived versions can be downloaded in following addresses:

4.5 Configuration

Configuration file is under "User Home":

Add parameter "config="FilePath"" when run jar to change configuration file temporarily.
Function "Settings" can be used to change configuration values.

4.6 Backup and Recover

1. To backup, copy directories to other places.

2. To recover, override current directories with backup directories.

3. Need not backup each directory under data path.

Predefined directories under data path are listed below:

4.7 Migration

1. Each version has itself’s configuration file. New version can copy parameters from existed versions.

2. Data handled in each version are under "Data Directory" referred by it. Multiple versions can refer to same data directory.

3. MyBox is backward compatibility: Later version can work on data of previous versions. While forward compatibility is not supported: Wrong may happen when old version handles data of new version.

5 Implementation

MyBox is based on following open sources:

6 Common Functions in Interfaces

6.1 Main Interface

Main interface is shown after MyBox is launched. Move mouse over one icon to pop its menu. Then select a tool to start.

6.2 Interface Layout

1. Window title includes the object name being handled.

2. Main menu in top to open windows of functions.

3. Some interfaces include pagination toolbar which is generally in bottom.

4. Some interface include icon Fish. Hover mouse upon it to pop tips.

5. Some interfaces include left pane or right pane. If icon Rosefinch is there, hover mouse upon it to hide/show the pane.

6. To some buttons, checkbox, or icon, shortcut or tips will be popped when hover mouse upon them.

6.3 Set Font Size

1. Decrease font size by press key "CTRL" and key "-" at same time.

2. Increase font size by press key "CTRL" and key "=" at same time.

3. Select one font size of 12px, 15px, and17px by click menu item directly.

4. Set font size in Setting window.

6.4 Open New Stage

To open new window for new scene and keep current scene in current window, do not select menu item "Settings"-"Close current window when open new tool".

6.5 Restore Scene Size

By selecting menu item "Settings"-"Record size and location of windows", recent size and location of each stage will be saved and restored when it is opened again.

6.6 Recent Visited Files/Directories

When menu item "Settings"-"Pop recent visited files/directories" is selected, each access of files/directories will be record and list will be popped when mouse is moved upon the button of selection. Example:

6.7 Data Table

1. To select rows:

• Press key SHIFT and click rows to select multiple rows of a range.

• Press key CTRL and click rows to select multiple rows one by one.

• Click the checkboxs in head of rows.

2. To edit data:

• Header texts of editable columns are in blue (Editable primary keys are still in red).

• Click the editable cell, then its input field will be shown.

• Press ESC to discard modification. Press ENTER to commit modification.

• Option to commit modification automatically when cell loses focus.

• When data is committed, its value will be checked and invalid data will be rejected.

3. To display/hide columns, click button "+" in right side of table header.

This operation does not affect data.

4. To adjust order of columns, click and drag column headers.

This operation does not affect data.

5. - To order rows:

• Click column header for ascending order by this column.

• Click column header again for descending order by this column.

• Click column header for thrid time to cancel ordering of this column.

• Press SHIFT and click more column headers to order by multiple columns.

This operation only affect current data in table.

6. Header texts of primary keys are in red and auto-increated keys are in orange.

6.8 Context Menu

1. This menu is popped when right click object like text, image, or table.

2. If interface includes button "Cloud", context menu will be popped when click this button.

6.9 Window "Examples"

Window "Examples" is popped when hover or click button "Examples".

6.10 Window "Histories"

Hover or click button "Histories" to pop window "Histories".

6.11 Color Block and Palette

1. Hover color block to pop color's information.

2. Click color block to pop window Palette, and select or edit colors.

7 Settings

Select "Settings..."in main menu to open window Settings.

7.1 Interface

1. Language, font size, icon size

2. Select hi-dpi icons(100x100) or common icons(40x40).

3. Color of buttons can be customized.

4. Whether restore last size of each scene.

5. Whether open new stage to display scene.

6. Whether show/Hide splitted panes when mouse passing.

7. Whether pop stage "Set Color" when mouse passing.

8. Font size, color, duration of popped messages.

7.2 Base

1. Maximum memory usage of JVM

2. Network timeouts

7.3 Data

1. Data path

2. Derby driver mode and batch size.

3. Whether pop recent visited files/directories. And the number.

4. Whether close alarm clocks when exit program.

7.4 PDF

Maximum main memory of PDF handling.

7.5 Image

1. Width and color of stroke and anchor. Whether anchors are solid.

2. Color to replace Alpha when Alpha is not supported. (Suggest as White)

3. Wdith of thumbnail

4. Maximum width to display sampled images

7.6 Map

Data keys of map

8 Window

1. Refresh/Reset/Full-screen/Top windows.

2. Close other windows.

3. Reboot MyBox.

4. Recent visited tools.

5. Snapshot of window/pane.

9 Windows List

1. Click "Windows List" in menu "Window" to open this interface.

2. Display all of currently showing windows in MyBox.

3. Select some windows, and click button "Close".

4. Select some windows, and click button "Always on top".

5. Select some windows, and click button "Disable always on top".

10 Clear expired data

1. Select "Clear Expired Data" in menu "Settings" to open this interface.

2. Select data to be handled.

3. While clearing expired data, do not read/write files/data by MyBox functions.

4. Option to clear expired data automatically before exit.

<End of Document>