guiSET.core

Class Frame

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.Container

guiSET.core.Frame

public class Frame
extends Container

Master Container that fills out entire sketch and controls the flow of events and rendering of the GUI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Frame.DrawTime guiSET can draw the GUI either before (Frame.DrawTime.PRE, default) the Processing sketchs draw() method or after (Frame.DrawTime.POST).
static class	Frame.RefreshMode

Nested classes/interfaces inherited from class guiSET.core.Control

Control.Constants, Control.ImageMode, Control.Predicate, Control.Predicate1<T>, Control.Predicate2<T,U>, Control.RenderingMethod, Control.Setter<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Frame.RefreshMode	CONTINOUS Draw frequency mode.
static Frame.DrawTime	DRAW_POST GUI Draw time Mode: Draw the GUI after the PApplet.draw() happens.The draw time mode needs to be specified at the beginning when Frame is created.
static Frame.DrawTime	DRAW_PRE GUI Draw time Mode: Draw the GUI before the PApplet.draw() happens.
static int	DROP_FILE
static int	DROP_STRING
static Frame.RefreshMode	EFFICIENT Draw frequency mode.
static Frame.RefreshMode	NO_LOOP Most efficient mode.

Fields inherited from class guiSET.core.TextBased

FONT_SIZE, LINE_HEIGHT, TEXT_ALIGN, TEXT_ALIGN_Y, TEXT_COLOR

Fields inherited from class guiSET.core.Control

ALL, ANCHOR_INACTIVE, AUTOSIZE_BOTH, AUTOSIZE_HEIGHT, AUTOSIZE_NONE, AUTOSIZE_WIDTH, BACKGROUND_COLOR, BACKGROUND_COLORS, BORDER, BORDER_COLOR, BORDER_RADIUS, BORDER_WIDTH, BUFFERED_RENDERING, COLORS, defaultRenderingMethod, FILL, FIT, FIT_INSIDE, FOREGROUND_COLOR, HOVER_COLOR, MARGIN, MARGIN_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, name, OPACITY, PADDING, PADDING_BOTTOM, PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PERCENTAGE_MODE, PIXEL_MODE, PRESSED_COLOR, SPACING, TEXT_PROPERTIES, UNBUFFERED_RENDERING

Constructor Summary

Constructors

Constructor and Description
Frame(PApplet pa) It is necessary to pass the sketch object here.
Frame(PApplet pa, Frame.DrawTime timeToDraw) Specify the draw time mode with this constructor.

Method Summary

Modifier and Type	Method and Description
void	addAutoAnchors(int... anchors) Add an anchor (types are TOP, RIGHT, BOTTOM, LEFT).
boolean	deregisterShortcut(Shortcut shortcut) If the shortcut has been removed returns true.
static Frame	getFrame() Get the one and only Frame.
int	getOffsetXToWindow() Get x coordinate of left side relative to window.
int	getOffsetYToWindow() Get x coordinate of left side relative to window.
static PApplet	getPApplet()
Frame.RefreshMode	getRefreshMode()
boolean	isAltDown() Check if the ALT key is currently being hold down
boolean	isControlDown() Check if the CONTROL key is currently being hold down
boolean	isMetaDown() Check if the META key is currently being hold down
boolean	isResizable() Check if application has been set to resizable.
boolean	isShiftDown() Check if the SHIFT key is currently being hold down
boolean	registerShortcut(Shortcut shortcut, Control.Predicate callback) Register a shortcut to the sketch and fire the given lambda callback when the combination is hit on the keyboard.
boolean	registerShortcut(Shortcut shortcut, Control.Predicate callback, boolean executeEvenIfFocusedElementOverridesNormalShortcuts) Register a shortcut to the sketch and fire the given lambda callback when the combination is hit on the keyboard.
boolean	registerShortcut(Shortcut shortcut, java.lang.String methodName) Register a shortcut to the sketch and fire the given method when the combination is hit on the keyboard.
boolean	registerShortcut(Shortcut shortcut, java.lang.String methodName, java.lang.Object target)
boolean	registerShortcut(Shortcut shortcut, java.lang.String methodName, java.lang.Object target, boolean executeEvenIfFocusedElementOverridesNormalShortcuts)
void	removeDropElementListener()
void	removeEnterWindowListener()
void	removeExitWindowListener()
void	removeExternalDropListener()
void	removeGuiInitializedListener()
void	removeKeyListener()
void	removeWindowFocusGainedListener()
void	removeWindowFocusLostListener()
void	removeWindowResizeListener()
void	setAnchor(int anchorType, int value) Set an anchor of type TOP BOTTOM, LEFT or RIGHT to a certain value.
void	setDropElementListener(Control.Predicate lambda)
void	setDropElementListener(Control.Predicate2<Control,Control> lambda)
void	setDropElementListener(java.lang.String methodName)
void	setDropElementListener(java.lang.String methodName, java.lang.Object target) Internal drop listener for any element in the application.
void	setEnterWindowListener(Control.Predicate lambda)
void	setEnterWindowListener(Control.Predicate1<MouseEvent> lambda)
void	setEnterWindowListener(java.lang.String methodName)
void	setEnterWindowListener(java.lang.String methodName, java.lang.Object target) Listen for the mouse entering the window.
void	setExitWindowListener(Control.Predicate lambda)
void	setExitWindowListener(Control.Predicate1<MouseEvent> lambda)
void	setExitWindowListener(java.lang.String methodName)
void	setExitWindowListener(java.lang.String methodName, java.lang.Object target) Listen for the mouse exiting the window.
void	setExternalDropListener(java.lang.String methodName)
void	setExternalDropListener(java.lang.String methodName, java.lang.Object target) External drop listener for data dropped to the application.
void	setGuiInitializedListener(Control.Predicate lambda)
void	setGuiInitializedListener(java.lang.String methodName)
void	setGuiInitializedListener(java.lang.String methodName, java.lang.Object target) Called when GUI is initialized and draw() runs for the first time.
void	setHeight(int height) Set height of element.
void	setIcon(PImage img) Set application icon.
void	setKeyListener(Control.Predicate lambda)
void	setKeyListener(Control.Predicate1<KeyEvent> lambda)
void	setKeyListener(java.lang.String methodName)
void	setKeyListener(java.lang.String methodName, java.lang.Object target) Set a key listener which fires on key press, type and release events.
void	setLocation(int x, int y) Set application location on computer screen.
void	setMaximumWindowSize(int maxWidth, int maxHeight) Set the maximum size of the application window.
void	setMinimumWindowSize(int minWidth, int minHeight) Set the minimum size of the application window.
void	setRefreshMode(Frame.RefreshMode mode) Set draw frequency mode EFFICIENT CONTINOUS NO_LOOP.
void	setResizable(boolean resizable) Make Application user-resizable.
void	setTitle(java.lang.String title) Set application title.
void	setWidth(int width) Set width of element.
void	setWindowFocusGainedListener(Control.Predicate lambda)
void	setWindowFocusGainedListener(java.lang.String methodName)
void	setWindowFocusGainedListener(java.lang.String methodName, java.lang.Object target) Fired when the window gained focus.
void	setWindowFocusLostListener(Control.Predicate lambda)
void	setWindowFocusLostListener(java.lang.String methodName)
void	setWindowFocusLostListener(java.lang.String methodName, java.lang.Object target) Fired when the window lost focus.
void	setWindowResizeListener(Control.Predicate lambda)
void	setWindowResizeListener(Control.Predicate1<MouseEvent> lambda)
void	setWindowResizeListener(java.lang.String methodName)
void	setWindowResizeListener(java.lang.String methodName, java.lang.Object target) Called when the application window is resized.
void	setWindowSize(int width, int height) Set the size of the application window.
void	setX(int x) Set x-coordinate of element relative to parent.
void	setY(int y) Set y-coordinate of element relative to parent.

Methods inherited from class guiSET.core.Container

add, clear, fitContent, getItem, getItems, getNumItems, indexOf, insert, remove, remove, sortItems, traceAbsoluteCoordinates, traceRelativeCoordinates

Methods inherited from class guiSET.core.TextBased

copyStyle, getFont, getFontSize, getLineHeight, getText, getTextAlign, getTextAlignY, getTextColor, isBold, isItalic, isStrikethrough, isUnderlined, setBold, setFont, setFontSize, setForegroundColor, setItalic, setLineHeight, setLineHeightPercent, setStrikethrough, setText, setText, setTextAlign, setTextAlignY, setTextColor, setUnderlined

Methods inherited from class guiSET.core.Control

animate, blur, copyStyle, doForAll, fillParent, fillParent, fillParent, fillParentHeight, fillParentHeight, fillParentWidth, fillParentWidth, focus, forceRepaint, getAnchorMode, getAnchorValue, getAvailableHeight, getAvailableWidth, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getCursor, getForegroundColor, getHeight, getHoverColor, getImage, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOffsetXToParent, getOffsetYToParent, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, setHoverColor, setImage, setImageMode, setMargin, setMargin, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseListener, setMouseListener, setMouseListener, setMouseListener, setOpacity, setOpacity, setPadding, setPadding, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPercentageAnchor, setPercentageAnchors, setPixelAnchor, setPixelAnchors, setPosition, setPressedColor, setResizeListener, setResizeListener, setResizeListener, setResizeListener, setSize, setVisibility, setVisible, setWidth, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Field Detail

DRAW_PRE

public static final Frame.DrawTime DRAW_PRE

GUI Draw time Mode: Draw the GUI before the PApplet.draw() happens. Useful when the user wants to image some own stuff upon the GUI. The draw time mode needs to be specified at the beginning when Frame is created. This is the default mode.

DRAW_POST

public static final Frame.DrawTime DRAW_POST

GUI Draw time Mode: Draw the GUI after the PApplet.draw() happens.The draw time mode needs to be specified at the beginning when Frame is created. Everything that is drawn during PApplet.draw() will be overwritten without ever being visible, except when Frame is transparent.

CONTINOUS

public static final Frame.RefreshMode CONTINOUS

Draw frequency mode. Continous makes Frame draw the entire GUI EACH time (standard is 60 times per sec) if it has changed or not. This is useful if guiSET is combined with manual drawing on the sketch but it is the most wasteful mode.This is the default and for many cases recommended mode.

EFFICIENT

public static final Frame.RefreshMode EFFICIENT

Draw frequency mode. Only refresh if an element has changed. It still keeps the PApplet.draw() loop running to check for some events but only redraws if necessary.

NO_LOOP

public static final Frame.RefreshMode NO_LOOP

Most efficient mode. The PApplet.draw() loop is interrupted and only key and mouse events are still received and can change the state of the GUI. Animation timing is not as good.

DROP_STRING

public static final int DROP_STRING

See Also:

Constant Field Values

DROP_FILE

public static final int DROP_FILE

See Also:

Constant Field Values

Constructor Detail

Frame

public Frame(PApplet pa)

It is necessary to pass the sketch object here. In most cases (if not in scope of a class) just use "this".

Parameters:

pa - papplet

Frame

public Frame(PApplet pa,
             Frame.DrawTime timeToDraw)

Specify the draw time mode with this constructor.

Parameters:

pa - papplet

timeToDraw - DRAW_PRE or DRAW_POST

Method Detail

getFrame

public static Frame getFrame()

Get the one and only Frame.

Returns:

Frame

getPApplet

public static PApplet getPApplet()

setRefreshMode

public void setRefreshMode(Frame.RefreshMode mode)

Set draw frequency mode EFFICIENT CONTINOUS NO_LOOP. It is no recommended to change the mode very frequently (like every few frames) to NO_LOOP and back to one of the others as thus might reduce performance.

Parameters:

mode - accepts Frame.EFFICIENT, Frame.CONTINOUS, Frame.NO_LOOP

getRefreshMode

public Frame.RefreshMode getRefreshMode()

registerShortcut

public boolean registerShortcut(Shortcut shortcut,
                                Control.Predicate callback)

Register a shortcut to the sketch and fire the given lambda callback when the combination is hit on the keyboard.

Parameters:

shortcut - shortcut to register

callback - lambda callback

Returns:

success

registerShortcut

public boolean registerShortcut(Shortcut shortcut,
                                Control.Predicate callback,
                                boolean executeEvenIfFocusedElementOverridesNormalShortcuts)

Register a shortcut to the sketch and fire the given lambda callback when the combination is hit on the keyboard.

Parameters:

shortcut - shortcut to register

callback - lambda callback

executeEvenIfFocusedElementOverridesNormalShortcuts - Should this shortcut even work when i.e. a textbox has focus?

Returns:

success

registerShortcut

public boolean registerShortcut(Shortcut shortcut,
                                java.lang.String methodName)

Register a shortcut to the sketch and fire the given method when the combination is hit on the keyboard.

Parameters:

shortcut - shortcut to register

methodName - method to execute when shortcut is pressed.

Returns:

true if registering has been successful.

registerShortcut

public boolean registerShortcut(Shortcut shortcut,
                                java.lang.String methodName,
                                java.lang.Object target)

Parameters:

shortcut - shortcut to register

methodName - method to execute when shortcut is pressed.

target - object that declares the callback method.

Returns:

true if registering has been successful.

See Also:

version with custom target object.

registerShortcut

public boolean registerShortcut(Shortcut shortcut,
                                java.lang.String methodName,
                                java.lang.Object target,
                                boolean executeEvenIfFocusedElementOverridesNormalShortcuts)

Parameters:

shortcut - shortcut to register

methodName - method to execute when shortcut is pressed.

target - object that declares the callback method.

executeEvenIfFocusedElementOverridesNormalShortcuts - Should this shortcut even work when a textbox has focus?

Returns:

true if registering has been successful.

See Also:

If strong is set to true then this shortcut will even work when a textbox has focus! Default is false.

deregisterShortcut

public boolean deregisterShortcut(Shortcut shortcut)

If the shortcut has been removed returns true. This is not the case if given shortcut has never been registered. The given shortcut does not need to be THE exact same as the registered one. It can be a new one with the same attributes.

Parameters:

shortcut - shortcut to deregister

Returns:

true if deregistering has been successful.

setIcon

public void setIcon(PImage img)

Set application icon.

Parameters:

img - icon image

setTitle

public void setTitle(java.lang.String title)

Set application title.

Parameters:

title - title

setResizable

public void setResizable(boolean resizable)

Make Application user-resizable. Default: false.

Parameters:

resizable - resizable

isResizable

public boolean isResizable()

Check if application has been set to resizable.

Returns:

resizable resizable

setLocation

public void setLocation(int x,
                        int y)

Set application location on computer screen.

Parameters:

x - in pixel from the left

y - in pixel from the top

setWindowSize

public void setWindowSize(int width,
                          int height)

Set the size of the application window.

Parameters:

width - width in pixel

height - height in pixel

setMinimumWindowSize

public void setMinimumWindowSize(int minWidth,
                                 int minHeight)

Set the minimum size of the application window.

Parameters:

minWidth - minimum width

minHeight - minimum height

setMaximumWindowSize

public void setMaximumWindowSize(int maxWidth,
                                 int maxHeight)

Set the maximum size of the application window.

Parameters:

maxWidth - maximum width

maxHeight - maximum height

setWidth

public void setWidth(int width)

Description copied from class: Control

Set width of element.

Overrides:

setWidth in class Control

Parameters:

width - width in pixel

setHeight

public void setHeight(int height)

Description copied from class: Control

Set height of element.

Overrides:

setHeight in class Control

Parameters:

height - height in pixel

setX

public void setX(int x)

Description copied from class: Control

Set x-coordinate of element relative to parent. Does not apply if element is added to containers that provide some own layout.

Overrides:

setX in class Control

Parameters:

x - x-coordinate in pixel

setY

public void setY(int y)

Description copied from class: Control

Set y-coordinate of element relative to parent. Does not apply if element is added to containers that provide some own layout.

Overrides:

setY in class Control

Parameters:

y - y-coordinate in pixel

addAutoAnchors

public void addAutoAnchors(int... anchors)

Description copied from class: Control

Add an anchor (types are TOP, RIGHT, BOTTOM, LEFT). Anchors ensure the element stays at fixed relative positions when the parent is resized. If opposite anchors are set, the element will be resized as well. When this function is called, the element will remember the CURRENT(!) distances to the parents bounds. Multiple anchors can be set with this method. This is currently only intended with Control.PIXEL_MODE and not with Control.PERCENTAGE_MODE (mode will be set to the Control.PIXEL_MODE if the latter is currently selected). It is not possible to use this method if this element has not been added to a parent.

Overrides:

addAutoAnchors in class Control

Parameters:

anchors - accepts TOP, RIGHT, LEFT or BOTTOM. Pass up to four anchor types (order doesn't matter)

setAnchor

public void setAnchor(int anchorType,
                      int value)

Description copied from class: Control

Set an anchor of type TOP BOTTOM, LEFT or RIGHT to a certain value. This also immediately sets the position or size of this element according to the anchors if necessary. It is not possible to use this method if this element has not been added to a parent container. This version sets the anchor without changing its type like Control.setPercentageAnchor(int, int) and Control.setPixelAnchor(int, int).

Overrides:

setAnchor in class Control

Parameters:

anchorType - anchor direction

value - value

setKeyListener

public void setKeyListener(java.lang.String methodName,
                           java.lang.Object target)

Set a key listener which fires on key press, type and release events. Event arguments: KeyEvent

Parameters:

methodName - method name

target - object

setKeyListener

public void setKeyListener(java.lang.String methodName)

setKeyListener

public void setKeyListener(Control.Predicate lambda)

setKeyListener

public void setKeyListener(Control.Predicate1<KeyEvent> lambda)

removeKeyListener

public void removeKeyListener()

setGuiInitializedListener

public void setGuiInitializedListener(java.lang.String methodName,
                                      java.lang.Object target)

Called when GUI is initialized and draw() runs for the first time. Event arguments: none

Parameters:

methodName - method name

target - object

setGuiInitializedListener

public void setGuiInitializedListener(java.lang.String methodName)

setGuiInitializedListener

public void setGuiInitializedListener(Control.Predicate lambda)

removeGuiInitializedListener

public void removeGuiInitializedListener()

setWindowResizeListener

public void setWindowResizeListener(java.lang.String methodName,
                                    java.lang.Object target)

Called when the application window is resized. Event arguments: MouseEvent

Parameters:

methodName - method name

target - object

setWindowResizeListener

public void setWindowResizeListener(java.lang.String methodName)

setWindowResizeListener

public void setWindowResizeListener(Control.Predicate lambda)

setWindowResizeListener

public void setWindowResizeListener(Control.Predicate1<MouseEvent> lambda)

removeWindowResizeListener

public void removeWindowResizeListener()

setEnterWindowListener

public void setEnterWindowListener(java.lang.String methodName,
                                   java.lang.Object target)

Listen for the mouse entering the window. Event arguments: MouseEvent

Parameters:

methodName - method name

target - object

setEnterWindowListener

public void setEnterWindowListener(java.lang.String methodName)

setEnterWindowListener

public void setEnterWindowListener(Control.Predicate lambda)

setEnterWindowListener

public void setEnterWindowListener(Control.Predicate1<MouseEvent> lambda)

removeEnterWindowListener

public void removeEnterWindowListener()

setExitWindowListener

public void setExitWindowListener(java.lang.String methodName,
                                  java.lang.Object target)

Listen for the mouse exiting the window. Event arguments: MouseEvent

Parameters:

methodName - method name

target - object

setExitWindowListener

public void setExitWindowListener(java.lang.String methodName)

setExitWindowListener

public void setExitWindowListener(Control.Predicate lambda)

setExitWindowListener

public void setExitWindowListener(Control.Predicate1<MouseEvent> lambda)

removeExitWindowListener

public void removeExitWindowListener()

setDropElementListener

public void setDropElementListener(java.lang.String methodName,
                                   java.lang.Object target)

Internal drop listener for any element in the application. First arg: dropped element, Second arg: target on which the first on has been dropped. Event arguments: Control, Control

Parameters:

methodName - method name

target - object

setDropElementListener

public void setDropElementListener(java.lang.String methodName)

setDropElementListener

public void setDropElementListener(Control.Predicate lambda)

setDropElementListener

public void setDropElementListener(Control.Predicate2<Control,Control> lambda)

removeDropElementListener

public void removeDropElementListener()

setWindowFocusGainedListener

public void setWindowFocusGainedListener(java.lang.String methodName,
                                         java.lang.Object target)

Fired when the window gained focus. Event arguments: none

Parameters:

methodName - method name

target - object

setWindowFocusGainedListener

public void setWindowFocusGainedListener(java.lang.String methodName)

setWindowFocusGainedListener

public void setWindowFocusGainedListener(Control.Predicate lambda)

removeWindowFocusGainedListener

public void removeWindowFocusGainedListener()

setWindowFocusLostListener

public void setWindowFocusLostListener(java.lang.String methodName,
                                       java.lang.Object target)

Fired when the window lost focus. Event arguments: none

Parameters:

methodName - method name

target - object

setWindowFocusLostListener

public void setWindowFocusLostListener(java.lang.String methodName)

setWindowFocusLostListener

public void setWindowFocusLostListener(Control.Predicate lambda)

removeWindowFocusLostListener

public void removeWindowFocusLostListener()

setExternalDropListener

public void setExternalDropListener(java.lang.String methodName,
                                    java.lang.Object target)

External drop listener for data dropped to the application. Event arguments:

1. int that describes data type (DROP_STRING or DROP_FILE)
2. Object instance that is the dropped data (needs casting to String or File)
3. Control instance - the element that the data has been dropped on

Parameters:

methodName - method name

target - object

setExternalDropListener

public void setExternalDropListener(java.lang.String methodName)

removeExternalDropListener

public void removeExternalDropListener()

getOffsetXToWindow

public int getOffsetXToWindow()

Description copied from class: Control

Get x coordinate of left side relative to window.

Overrides:

getOffsetXToWindow in class Control

Returns:

absolute x

getOffsetYToWindow

public int getOffsetYToWindow()

Description copied from class: Control

Get x coordinate of left side relative to window.

Overrides:

getOffsetYToWindow in class Control

Returns:

absolute y

isControlDown

public boolean isControlDown()

Check if the CONTROL key is currently being hold down

Returns:

true if control key is down

isShiftDown

public boolean isShiftDown()

Check if the SHIFT key is currently being hold down

Returns:

true if shift key is down

isAltDown

public boolean isAltDown()

Check if the ALT key is currently being hold down

Returns:

true if alt key is down

isMetaDown

public boolean isMetaDown()

Check if the META key is currently being hold down

Returns:

true if meta key is down