io.github.bananapuncher714.radioboard.providers.canvas

Class RadioIconFactory

java.lang.Object

io.github.bananapuncher714.radioboard.providers.canvas.RadioIconFactory

public final class RadioIconFactory
extends java.lang.Object

Construct various RadioIcons from given parameters

Author:

BananaPuncher714

Method Summary

Modifier and Type	Method and Description
static RadioIconButton	constructButton(java.awt.Image clicked, java.awt.Image unclicked, int width, int height, java.lang.String command, long buttonDelay) Construct a normal button
static RadioIconCloud	constructCloud(int width, int height, int transparency, int delay) Constructs a dynamic cloudy filter
static RadioIconGif	constructGif(java.io.File file, int width, int height) Create a new GIF icon
static RadioIconImage	constructImage(java.awt.Image image, int width, int height) Creates a static image RadioIconImage
static RadioIconSwitch	constructSwitch(java.awt.Image on, java.awt.Image off, int width, int height, java.lang.String commandOn, java.lang.String commandOff) Gets a new RadioIconSwitch

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

constructSwitch

public static RadioIconSwitch constructSwitch(java.awt.Image on,
                                              java.awt.Image off,
                                              int width,
                                              int height,
                                              java.lang.String commandOn,
                                              java.lang.String commandOff)

Gets a new RadioIconSwitch

Parameters:

on - The image when the switch is on

off - The image when the switch is off

width - The width in pixels of the switch

height - The height in pixels of the switch

commandOn - A command that is ran when the switch is turned on

commandOff - A command that is ran when the switch is turned off

Returns:

A RadioIconSwitch made from all the parameters

constructImage

public static RadioIconImage constructImage(java.awt.Image image,
                                            int width,
                                            int height)

Creates a static image RadioIconImage

Parameters:

image - The image to show

width - The new width

height - The new height

Returns:

constructButton

public static RadioIconButton constructButton(java.awt.Image clicked,
                                              java.awt.Image unclicked,
                                              int width,
                                              int height,
                                              java.lang.String command,
                                              long buttonDelay)

Construct a normal button

Parameters:

clicked - The clicked image

unclicked - The unclicked image

width - Width of the button

height - Height of the button

command - Command that will be executed when pressed

buttonDelay - How long the button stays depressed

Returns:

constructGif

public static RadioIconGif constructGif(java.io.File file,
                                        int width,
                                        int height)

Create a new GIF icon

Parameters:

file - The gif file

width - Width of the gif

height - Height of the gif

Returns:

constructCloud

public static RadioIconCloud constructCloud(int width,
                                            int height,
                                            int transparency,
                                            int delay)

Constructs a dynamic cloudy filter

Parameters:

width - Width of the cloud effect

height - Height of the cloud effect

transparency - Transparency of the cloud

delay - How fast it updates in milliseconds, do not make this too fast or the client will timeout

Returns: