Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Oshan96/CustomStage

A JavaFX UI framework to create fully customized undecorated windows
https://github.com/Oshan96/CustomStage

api customstage framework java javafx javafx-frameworks javafx-library jitpack stage tool undecorated-stage undecorator wiki

Last synced: 3 months ago
JSON representation

A JavaFX UI framework to create fully customized undecorated windows

Host: GitHub
URL: https://github.com/Oshan96/CustomStage
Owner: Oshan96
License: apache-2.0
Created: 2018-03-11T14:59:57.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2021-10-17T16:35:57.000Z (about 3 years ago)
Last Synced: 2024-02-13T10:03:39.928Z (9 months ago)
Topics: api, customstage, framework, java, javafx, javafx-frameworks, javafx-library, jitpack, stage, tool, undecorated-stage, undecorator, wiki
Language: Java
Homepage:
Size: 379 KB
Stars: 196
Watchers: 17
Forks: 18
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

AwesomeJavaFX - CustomStage - CustomStage is a fully customizable Undecorated JavaFX stage (window) with amazing features. (Libraries, Tools and Projects)

README

        


# CustomStage  [![Mentioned in Awesome JavaFX](https://awesome.re/mentioned-badge.svg)](https://github.com/mhrimaz/AwesomeJavaFX)

A JavaFX undecorated stage which can fully be customized

[![Download](https://api.bintray.com/packages/oshan96/CustomStage/lk.vivoxalabs.customstage/images/download.svg) ](https://bintray.com/oshan96/CustomStage/lk.vivoxalabs.customstage/_latestVersion)

![Licence(https://img.shields.io/github/license/Oshan96/CustomStage.svg)](https://img.shields.io/github/license/Oshan96/CustomStage.svg)

[![Total Downloads](https://img.shields.io/github/downloads/Oshan96/CustomStage/total.svg)](https://github.com/Oshan96/CustomStage/releases)

[![JitPack](https://jitpack.io/v/Oshan96/CustomStage.svg)](https://jitpack.io/#Oshan96/CustomStage)

[![HitCount](http://hits.dwyl.io/Oshan96/CustomStage.svg)](http://hits.dwyl.io/Oshan96/CustomStage)

![](https://img.shields.io/badge/Bintray%20Downloads-500%2B-brightgreen.svg)

## Donations

If this project is helpful to you and love my work and feel like showing love/appreciation, would you like to buy me a coffee?




> An Implementation [See the code in wiki at "A complete implementation"](https://github.com/Oshan96/CustomStage/wiki#a-complete-implementation)

![CustomStage Implementation](https://thumbs.gfycat.com/JampackedDetailedJapanesebeetle-size_restricted.gif)

## Additional Tools provided (After v1.3.0)

- [FileLoader](https://github.com/Oshan96/CustomStage/blob/master/src/main/java/lk/vivoxalabs/scenemanager/tools/FileLoader.java)

- [SceneManager](https://github.com/Oshan96/CustomStage/blob/master/src/main/java/lk/vivoxalabs/scenemanager/SceneManager.java)

> ## Checkout the [CustomStage Wiki][wiki] for more examples and documentation.

## Using CustomStage ? 

- **Fork the repository** and update with this readme's [Projects using CustomStage](#projects-using-customstage) section in the following format adding your project details and do a **_Pull Request!_**

> Project_Name : Brief_Description

## Projects using CustomStage

- [RentLio](https://github.com/Shehanka/RentLio) : This is a vehicle reservation system. Which is made with JavaFX and also using hibernate and RMI.

## Overview

This CustomStage is a JavaFX undecorated Stage. To put it simple, CustomStage is a Window and you can add different views (FXML files)

to the window (like changing the scene of the window) as you prefer.

The basic problem making the Stage "Undecorated" is that you will not be able to,

  1) Resize the window using mouse.

  2) Lose the default action buttons.

  3) Move the window (by dragging) (etc.)

So, CustomStage will get rid of all of these issues since it includes,

  1) Window resizing (the ResizeHelper class is used here with minor modifications) -> [ResizeHelper class](https://stackoverflow.com/questions/19455059/allow-user-to-resize-an-undecorated-stage)

  2) Default action buttons and their behaviour (close, maximize/restore, minimize)

  3) Window dragging 

  

### What else?

- Window is **_automatically scaled_** as for screen resolution

- Very **_responsive_**

- Apart from those, this is called **CustomStage** since it **_can be customized as you wish_**

#### How?

- Easy. You can get your customized Stage using the [**CustomStageBuilder**](src/main/java/lk/vivoxalabs/customstage/CustomStageBuilder.java) class. 

  This class includes all the methods you will need to customize your window.

## How to use?

**Starting from version 1.3.1 CustomStage releases are/will be available through JCenter and MavenCentral**

### Maven 

```xml

    lk.vivoxalabs.customstage

    CustomStage

    1.3.2

```

### Gradle 

```

  dependencies {

    compile 'lk.vivoxalabs.customstage:CustomStage:1.3.2'

  }

```

### Download via Jitpack (Will not be possible for releases after v1.3.1)

- v1.3.1 CustomStage via JitPack (See the releases here : https://jitpack.io/#Oshan96/CustomStage)

### Gradle

> Add jitpack as a repository

```

repositories {

    maven { url 'https://jitpack.io' }

}

```

> Add dependancy

```

dependencies {

    compile 'com.github.Oshan96:CustomStage:v1.3.1'

}

```

### Maven 

> Add jitpack as a repository

```xml

  

    jitpack.io

    https://jitpack.io

  

```

> Add dependancy 

```xml

  com.github.Oshan96

  CustomStage

  v1.3.1

```

### Or download and add as a dependancy to your project

- **Binaries** can be found at [**CustomStage binaries**](https://bintray.com/oshan96/CustomStage/lk.vivoxalabs.customstage/_latestVersion)

## How to use a CustomStage?

- An example is provided in [**How to use a CustomStage**](examples/v1_0_0/StageTest.java) for a complete implementation

![CustomStage](https://preview.ibb.co/mJrs2x/Custom_Stage.png)

- To achieve transparency, see [**Transparent CustomStage**](examples/v1_0_0/TransparentStage.java)

![Transparent CustomStage](https://preview.ibb.co/bWvfpc/Transparent.png)

- CustomStage with custom icons for (close,minimize,maximize/restore) buttons [**CustomStage with custom icons**](examples/v1_0_0/CustomIconStage.java)

![CustomStage with custom icons](https://preview.ibb.co/jzJN2x/custom_Icon.png)

## Documentation

CustomStage API Documentation can be found here : [CustomStage Documentation](https://oshan96.github.io/CustomStage/)

### Any issue detected?

![:D](https://lh3.googleusercontent.com/SVKzPc8BQlUkxqPY87sn2SGomGAxhkqRHSQDw53EhGGbth2tbebxMtiSmX7MQ3augQ=w300)

**Feel free to post issues in "Issues" for further improvements** 

[imgLogo]: https://i.imgur.com/uV4rDEM.png

[wiki]: https://github.com/Oshan96/CustomStage/wiki