Control (Javadocs: guiSET)

java.lang.Object
- guiSET.core.Control

Direct Known Subclasses:

Slider, TextBased
```
public abstract class Control
extends java.lang.Object
```
(Abstract) Base class for all other visual components. It provides all basic style attributes and methods. It also comes with the essential event handling and some useful default rendering methods.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Control.Constants`
`static class`	`Control.ImageMode` Fill modes for background images.
`static interface`	`Control.Predicate` Functional interface for a lambda expression with no parameters.
`static interface`	`Control.Predicate1<T>` Functional interface for a lambda expression with one parameter.
`static interface`	`Control.Predicate2<T,U>` Functional interface for a lambda expression with two parameters.
`static class`	`Control.RenderingMethod` guiSET provides two rendering methods and for each element, the method can be chosen.
`static class`	`Control.Setter<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`ALL`
`static int`	`ANCHOR_INACTIVE` The value of an inactive anchor is set to `ANCHOR_INACTIVE`.
`static int`	`AUTOSIZE_BOTH`
`static int`	`AUTOSIZE_HEIGHT`
`static int`	`AUTOSIZE_NONE`
`static int`	`AUTOSIZE_WIDTH`
`static long`	`BACKGROUND_COLOR`
`static long`	`BACKGROUND_COLORS`
`static long`	`BORDER`
`static long`	`BORDER_COLOR`
`static long`	`BORDER_RADIUS`
`static long`	`BORDER_WIDTH`
`static Control.RenderingMethod`	`BUFFERED_RENDERING` Elements graphics are drawn on a buffer image.
`static long`	`COLORS`
`static Control.RenderingMethod`	`defaultRenderingMethod` Specify rendering type for any new element instances.
`static Control.ImageMode`	`FILL` Image mode: fill element with given image and if necessary, distort the image
`static Control.ImageMode`	`FIT` Image mode: enlarge image so it fills out entire object centered, parts of the image might be hidden; fits the larger side
`static Control.ImageMode`	`FIT_INSIDE` Image mode: place image centered in the object without cropping it, so it fits the smaller side
`static long`	`FONT_SIZE`
`static long`	`FOREGROUND_COLOR`
`static long`	`HOVER_COLOR`
`static long`	`LINE_HEIGHT`
`static long`	`MARGIN`
`static long`	`MARGIN_BOTTOM`
`static long`	`MARGIN_LEFT`
`static long`	`MARGIN_RIGHT`
`static long`	`MARGIN_TOP`
`java.lang.String`	`name` Name for the element can be specified manually, useful for distinguishing.
`static long`	`OPACITY`
`static long`	`PADDING`
`static long`	`PADDING_BOTTOM`
`static long`	`PADDING_LEFT`
`static long`	`PADDING_RIGHT`
`static long`	`PADDING_TOP`
`static boolean`	`PERCENTAGE_MODE` Anchor mode for percentage of parents size.
`static boolean`	`PIXEL_MODE` Anchor mode for absolute pixel values.
`static long`	`PRESSED_COLOR`
`static long`	`SPACING`
`static long`	`TEXT_ALIGN`
`static long`	`TEXT_ALIGN_Y`
`static long`	`TEXT_COLOR`
`static long`	`TEXT_PROPERTIES`
`static Control.RenderingMethod`	`UNBUFFERED_RENDERING` Elements graphics are drawn on parent buffer.

Constructor Summary

Constructors
Constructor and Description

Control()

Constructors
Constructor and Description
`Control()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAutoAnchors(int... anchor)` Add an anchor (types are TOP, RIGHT, BOTTOM, LEFT).
`void`	`animate(java.lang.String attribute, float aimedValue, double milliseconds)` Create a transition animation for a property of this Component.
`void`	`blur()` Request the Frame component to blur this object (set focus to false).
`void`	`copyStyle(Control source)` Enable user of the library to adopt a set of visual properties from another element.
`void`	`copyStyle(Control source, long attribs)` Enable user of the library to adopt a set of visual style properties from another element.
`static <T> void`	`doForAll(Control.Setter<T> setter, T... elements)` (A bit more advanced!)
`void`	`fillParent()` Fill parent width and height.
`void`	`fillParent(int percent)` Fill x percent of parents width and height.
`void`	`fillParent(int widthPercent, int heightPercent)` Fill widthPercent of parent width and heightPercent of parent height.
`void`	`fillParentHeight()` Fill parent height.
`void`	`fillParentHeight(int percent)` Fill x percent of parent height and center this element vertically.
`void`	`fillParentWidth()` Fill parent width.
`void`	`fillParentWidth(int percent)` Fill x percent of parent width and center this element horizontally.
`void`	`focus()` Request the Frame component to focus this object.
`void`	`forceRepaint()` Force a re-render of this Component.
`boolean`	`getAnchorMode(int anchor)` Get anchor mode for given anchor direction.
`int`	`getAnchorValue(int anchor)` Get the value of an anchor, returns `ANCHOR_INACTIVE` if the anchor is inactive.
`int`	`getAvailableHeight()` Get available content height subtracting paddings.
`int`	`getAvailableWidth()` Get available content width subtracting paddings.
`int`	`getBackgroundColor()`
`int`	`getBorderColor()`
`int`	`getBorderRadius()`
`int`	`getBorderWidth()`
`int`	`getCursor()`
`int`	`getForegroundColor()`
`int`	`getHeight()`
`int`	`getHoverColor()`
`PImage`	`getImage()`
`int`	`getMarginBottom()`
`int`	`getMarginLeft()`
`int`	`getMarginRight()`
`int`	`getMarginTop()`
`int`	`getMaxHeight()`
`int`	`getMaxWidth()`
`int`	`getMinHeight()`
`int`	`getMinWidth()`
`int`	`getOffsetXToParent()` Get x coordinate of left side relative to parent.
`int`	`getOffsetXToWindow()` Get x coordinate of left side relative to window.
`int`	`getOffsetYToParent()` Get y coordinate of left side relative to parent.
`int`	`getOffsetYToWindow()` Get x coordinate of left side relative to window.
`float`	`getOpacity()`
`int`	`getPaddingBottom()`
`int`	`getPaddingLeft()`
`int`	`getPaddingRight()`
`int`	`getPaddingTop()`
`Control`	`getParent()`
`int`	`getPressedColor()`
`static java.lang.String`	`getVersionString()` Get guiSET version.
`int`	`getWidth()`
`int`	`getX()`
`int`	`getY()`
`int`	`getZ()`
`boolean`	`isEnabled()`
`boolean`	`isFocusable()`
`boolean`	`isFocused()`
`static boolean`	`isPropagationStopped()` Check if the mouse event propagation has been stopped.
`boolean`	`isVisible()`
`void`	`noAutosize()` Disable autosizing.
`boolean`	`relativeCoordsAreWithin(int x, int y)` Check if given coordinates (need to be relative to parent) are within this element (without constraining to parents bounds).
`void`	`removeAnchor(int anchor)` Remove a set anchor.
`void`	`removeBoxShadow()`
`void`	`removeFocusListener()`
`void`	`removeMouseListener(java.lang.String type)` Remove a mouse listener for given type if one has already been set up.
`void`	`removeResizeListener()`
`void`	`setAnchor(int anchor, int value)` Set an anchor of type TOP BOTTOM, LEFT or RIGHT to a certain value.
`void`	`setAnchors(int... anchors_and_values)` Set any number of anchors by passing first a direction and then the value (more than four - one for each direction - don't make sense though).
`void`	`setAutosizing(boolean autosizing)` Enable/disable autosizing.
`void`	`setBackgroundColor(int clr)` Set the plain background color of the element.
`void`	`setBorder(int borderWidth, int borderColor)` Shorthand property for setting border width and color.
`void`	`setBorder(int borderWidth, int borderColor, int borderRadius)` Shorthand property for setting all border properties.
`void`	`setBorderColor(int clr)` Color of elements border.
`void`	`setBorderRadius(int borderRadius)` Rounds the corners of the element.
`void`	`setBorderWidth(int borderWidth)` Stroke width of the elements border.
`void`	`setBoxShadow(int size, int offsetX, int offsetY, int color, float opacity)` Add rectangular box shadow to element.
`void`	`setCursor(int cursor)` Set the cursor displayed when mouse is over this element.
`void`	`setEnabled(boolean enabled)` Set the enabled state of this element.
`void`	`setFixedSize(int width, int height)` Set size of element and disable autosizing.
`void`	`setFocusListener(Control.Predicate lambda)` Set a lambda focus listener that fires when the element gets focus (through mouse click, programmatically).
`void`	`setFocusListener(Control.Predicate1<Control> lambda)` Set a lambda focus listener with a `Control` as parameter that fires when the element gets focus (through mouse click, programmatically).
`void`	`setFocusListener(java.lang.String methodName)`
`void`	`setFocusListener(java.lang.String methodName, java.lang.Object target)` Set a focus listener that fires when the element gets focus (through mouse click or programmatically).
`void`	`setForegroundColor(int clr)` Set the foreground color (not really used anymore, except in slider and knob).
`void`	`setGradient(int topColor, int bottomColor)` Set background to a vertical gradient between the two given colors.
`void`	`setHeight(float height)` Convenience version that casts to int!
`void`	`setHeight(int height)` Set height of element.
`void`	`setHoverColor(int clr)` Background color when mouse hovers over this component.
`void`	`setImage(PImage image)` Set the (background) image of the element.
`void`	`setImageMode(Control.ImageMode imageMode)` Set the background image filling mode.
`void`	`setMargin(int all)` Apply margins to all sides of the element.
`void`	`setMargin(int top_bottom, int left_right)` Apply same margins to both top/bottom and left/right.
`void`	`setMargin(int top, int right, int bottom, int left)` Set individual top, right, bottom and left margins.
`void`	`setMarginBottom(int bottom)`
`void`	`setMarginLeft(int left)`
`void`	`setMarginRight(int right)`
`void`	`setMarginTop(int top)`
`void`	`setMaxHeight(int maxHeight)` Set maximum height of element in pixel.
`void`	`setMaxWidth(int maxWidth)` Set maximum width of element in pixel.
`void`	`setMinHeight(int minHeight)` Set minimum height of element in pixel.
`void`	`setMinWidth(int minWidth)` Set minimum width of element in pixel.
`void`	`setMouseListener(java.lang.String type, Control.Predicate lambda)` Set a mouse listener in form of a lambda expression.
`void`	`setMouseListener(java.lang.String type, Control.Predicate1<MouseEvent> lambda)` Set a mouse listener in form of a lambda expression with a `MouseEvent` as argument.
`boolean`	`setMouseListener(java.lang.String type, java.lang.String methodName)` Set a mouse listener.
`boolean`	`setMouseListener(java.lang.String type, java.lang.String methodName, java.lang.Object target)` Allows to pass a target object where the given method is declared.
`void`	`setOpacity(double opacity)` Set opacity (opposite of transparency), casts to float.
`void`	`setOpacity(float opacity)` Set opacity (opposite of transparency).
`void`	`setPadding(int all)` Apply same padding to all sides
`void`	`setPadding(int top_bottom, int left_right)`
`void`	`setPadding(int top, int right, int bottom, int left)` Apply individual padding to all sides of the element.
`void`	`setPaddingBottom(int bottom)`
`void`	`setPaddingLeft(int left)`
`void`	`setPaddingRight(int right)`
`void`	`setPaddingTop(int top)`
`void`	`setPercentageAnchor(int anchor, int value)` Set an anchor like in `PERCENTAGE_MODE`.
`void`	`setPercentageAnchors(int... anchors_and_values)` Combination of `setAnchors(int...)` and `setPercentageAnchor(int, int)`.
`void`	`setPixelAnchor(int anchor, int value)` Set an anchor like with `setAnchor(int, int)` but definitely use the `PIXEL_MODE`.
`void`	`setPixelAnchors(int... anchors_and_values)` Combination of `setAnchors(int...)` and `setPixelAnchor(int, int)`.
`void`	`setPosition(int x, int y)` Set position relative to parent.
`void`	`setPressedColor(int clr)` Background color when mouse is pressed down on this component.
`void`	`setResizeListener(Control.Predicate lambda)` Set a lambda focus listener that fires each time the element is resized by anchor resizing.
`void`	`setResizeListener(Control.Predicate1<Control> lambda)` Set a lambda focus listener with a `Control` as parameter that fires each time the element is resized by anchor resizing.
`void`	`setResizeListener(java.lang.String methodName)`
`void`	`setResizeListener(java.lang.String methodName, java.lang.Object target)` Set a resize listener that fires each time the element is resized by anchor resizing.
`void`	`setSize(int width, int height)` Set width and height of element.
`void`	`setVisibility(boolean visible)` Just in case someone expects a "setVisibility" method instead of "setVisible".
`void`	`setVisible(boolean visible)` Set the visibility.
`void`	`setWidth(float width)` Convenience version that casts to int!
`void`	`setWidth(int width)` Set width of element.
`void`	`setX(int x)` Set x-coordinate of element relative to parent.
`void`	`setY(int y)` Set y-coordinate of element relative to parent.
`void`	`setZ(int z)` Set z-coordinate of element.
`static void`	`stopPropagation()` Stop mouse event propagation.
`void`	`unfocus()` Request the Frame component to blur this object (set focus to false), duplicate of `blur()`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
public java.lang.String name
```
    Name for the element can be specified manually, useful for distinguishing. This property has no effect on the looks.
  - FILL
```
public static final Control.ImageMode FILL
```
    Image mode: fill element with given image and if necessary, distort the image
  - FIT
```
public static final Control.ImageMode FIT
```
    Image mode: enlarge image so it fills out entire object centered, parts of the image might be hidden; fits the larger side
  - FIT_INSIDE
```
public static final Control.ImageMode FIT_INSIDE
```
    Image mode: place image centered in the object without cropping it, so it fits the smaller side
  - BUFFERED_RENDERING
```
public static final Control.RenderingMethod BUFFERED_RENDERING
```
    Elements graphics are drawn on a buffer image. This element needs to be re-rendered only if it changed and not if siblings or parents changed. This saves CPU resources but needs more memory.
  - UNBUFFERED_RENDERING
```
public static final Control.RenderingMethod UNBUFFERED_RENDERING
```
    Elements graphics are drawn on parent buffer. Each change of any element makes a re-rendering of this element necessary. There are exceptions though: if this parents mode is BUFFERED_RENDERING and a sibling of the parent has changed, then the element that is buffered by the parent needs no redrawing.
  - defaultRenderingMethod
```
public static Control.RenderingMethod defaultRenderingMethod
```
    Specify rendering type for any new element instances.
  - ANCHOR_INACTIVE
```
public static final int ANCHOR_INACTIVE
```
    The value of an inactive anchor is set to ANCHOR_INACTIVE.
    
    See Also:
    
    Constant Field Values
  - PERCENTAGE_MODE
```
public static final boolean PERCENTAGE_MODE
```
    Anchor mode for percentage of parents size.
    
    See Also:
    
    Constant Field Values
  - PIXEL_MODE
```
public static final boolean PIXEL_MODE
```
    Anchor mode for absolute pixel values.
    
    See Also:
    
    Constant Field Values
  - AUTOSIZE_NONE
```
public static int AUTOSIZE_NONE
```
  - AUTOSIZE_WIDTH
```
public static int AUTOSIZE_WIDTH
```
  - AUTOSIZE_HEIGHT
```
public static int AUTOSIZE_HEIGHT
```
  - AUTOSIZE_BOTH
```
public static int AUTOSIZE_BOTH
```
  - PADDING_LEFT
```
public static final long PADDING_LEFT
```
    See Also:
    
    Constant Field Values
  - PADDING_RIGHT
```
public static final long PADDING_RIGHT
```
    See Also:
    
    Constant Field Values
  - PADDING_TOP
```
public static final long PADDING_TOP
```
    See Also:
    
    Constant Field Values
  - PADDING_BOTTOM
```
public static final long PADDING_BOTTOM
```
    See Also:
    
    Constant Field Values
  - PADDING
```
public static final long PADDING
```
    See Also:
    
    Constant Field Values
  - MARGIN_LEFT
```
public static final long MARGIN_LEFT
```
    See Also:
    
    Constant Field Values
  - MARGIN_RIGHT
```
public static final long MARGIN_RIGHT
```
    See Also:
    
    Constant Field Values
  - MARGIN_TOP
```
public static final long MARGIN_TOP
```
    See Also:
    
    Constant Field Values
  - MARGIN_BOTTOM
```
public static final long MARGIN_BOTTOM
```
    See Also:
    
    Constant Field Values
  - MARGIN
```
public static final long MARGIN
```
    See Also:
    
    Constant Field Values
  - BACKGROUND_COLOR
```
public static final long BACKGROUND_COLOR
```
    See Also:
    
    Constant Field Values
  - HOVER_COLOR
```
public static final long HOVER_COLOR
```
    See Also:
    
    Constant Field Values
  - PRESSED_COLOR
```
public static final long PRESSED_COLOR
```
    See Also:
    
    Constant Field Values
  - BACKGROUND_COLORS
```
public static final long BACKGROUND_COLORS
```
    See Also:
    
    Constant Field Values
  - FOREGROUND_COLOR
```
public static final long FOREGROUND_COLOR
```
    See Also:
    
    Constant Field Values
  - BORDER_WIDTH
```
public static final long BORDER_WIDTH
```
    See Also:
    
    Constant Field Values
  - BORDER_COLOR
```
public static final long BORDER_COLOR
```
    See Also:
    
    Constant Field Values
  - BORDER_RADIUS
```
public static final long BORDER_RADIUS
```
    See Also:
    
    Constant Field Values
  - BORDER
```
public static final long BORDER
```
    See Also:
    
    Constant Field Values
  - OPACITY
```
public static final long OPACITY
```
    See Also:
    
    Constant Field Values
  - TEXT_COLOR
```
public static final long TEXT_COLOR
```
    See Also:
    
    Constant Field Values
  - FONT_SIZE
```
public static final long FONT_SIZE
```
    See Also:
    
    Constant Field Values
  - TEXT_ALIGN
```
public static final long TEXT_ALIGN
```
    See Also:
    
    Constant Field Values
  - TEXT_ALIGN_Y
```
public static final long TEXT_ALIGN_Y
```
    See Also:
    
    Constant Field Values
  - LINE_HEIGHT
```
public static final long LINE_HEIGHT
```
    See Also:
    
    Constant Field Values
  - TEXT_PROPERTIES
```
public static final long TEXT_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - COLORS
```
public static final long COLORS
```
    See Also:
    
    Constant Field Values
  - SPACING
```
public static final long SPACING
```
    See Also:
    
    Constant Field Values
  - ALL
```
public static final long ALL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Control
```
public Control()
```
- Method Detail
  - focus
```
public void focus()
```
    Request the Frame component to focus this object. The Frame decides upon the demand and can set this elements focused state to true. There can only be one focused element at a time and it is stored in the Frames focusedElement property.
    
    See Also:
    
    Frame.focusedElement
  - blur
```
public void blur()
```
    Request the Frame component to blur this object (set focus to false).
    
    See Also:
    
    Frame.focusedElement
  - unfocus
```
public void unfocus()
```
    Request the Frame component to blur this object (set focus to false), duplicate of blur().
    
    See Also:
    
    Frame.focusedElement
  - setBoxShadow
```
public void setBoxShadow(int size,
                         int offsetX,
                         int offsetY,
                         int color,
                         float opacity)
```
    Add rectangular box shadow to element.
    
    Parameters:
    
    size - shadow size
    
    offsetX - x offset
    
    offsetY - y offset
    
    color - shadow color
    
    opacity - shadow opacity (0 is transparent, 1 is opaque)
  - removeBoxShadow
```
public void removeBoxShadow()
```
  - forceRepaint
```
public void forceRepaint()
```
    Force a re-render of this Component. This shouldn't be needed, but just in case.
  - setAnchor
```
public void setAnchor(int anchor,
                      int value)
```
    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 setPercentageAnchor(int, int) and setPixelAnchor(int, int).
    
    Parameters:
    
    anchor - anchor direction
    
    value - value
  - setAnchors
```
public void setAnchors(int... anchors_and_values)
```
    Set any number of anchors by passing first a direction and then the value (more than four - one for each direction - don't make sense though). The anchor mode (PIXEL_MODE or PERCENTAGE_MODE is not changed. Example: setAnchors(LEFT, 34, RIGHT, 50); setAnchors(BOTTOM, 0, LEFT, 1, RIGHT, 20, TOP, 50);
    
    Parameters:
    
    anchors_and_values - anchors and values
  - setPixelAnchor
```
public void setPixelAnchor(int anchor,
                           int value)
```
    Set an anchor like with setAnchor(int, int) but definitely use the PIXEL_MODE. The anchor will be set to [value] pixels.
    
    Parameters:
    
    anchor - LEFT, RIGHT, TOP or BOTTOM
    
    value - value
  - setPixelAnchors
```
public void setPixelAnchors(int... anchors_and_values)
```
    Combination of setAnchors(int...) and setPixelAnchor(int, int).
    
    Parameters:
    
    anchors_and_values - anchors and values
  - setPercentageAnchor
```
public void setPercentageAnchor(int anchor,
                                int value)
```
    Set an anchor like in PERCENTAGE_MODE. This will place or resize the element in percent relative to the size of the parent (give i.e. 100 for 100%).
    
    Parameters:
    
    anchor - anchor
    
    value - value
  - setPercentageAnchors
```
public void setPercentageAnchors(int... anchors_and_values)
```
    Combination of setAnchors(int...) and setPercentageAnchor(int, int).
    
    Parameters:
    
    anchors_and_values - anchors and values
  - getAnchorMode
```
public boolean getAnchorMode(int anchor)
```
    Get anchor mode for given anchor direction. Returns a boolean PIXEL_MODE (false) or PERCENTAGE_MODE (true).
    
    Parameters:
    
    anchor - anchor direction
    
    Returns:
    
    anchor mode
  - getAnchorValue
```
public int getAnchorValue(int anchor)
```
    Get the value of an anchor, returns ANCHOR_INACTIVE if the anchor is inactive.
    
    Parameters:
    
    anchor - anchor direction
    
    Returns:
    
    anchor value in pixel or percent, depending on corresponding nchor mode
  - addAutoAnchors
```
public void addAutoAnchors(int... anchor)
```
    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 PIXEL_MODE and not with PERCENTAGE_MODE (mode will be set to the 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.
    
    Parameters:
    
    anchor - accepts TOP, RIGHT, LEFT or BOTTOM. Pass up to four anchor types (order doesn't matter)
  - removeAnchor
```
public void removeAnchor(int anchor)
```
    Remove a set anchor. Removing the last anchor will set all anchor.
    
    Parameters:
    
    anchor - accepts TOP, RIGHT, LEFT or BOTTOM
  - fillParentWidth
```
public void fillParentWidth(int percent)
```
    Fill x percent of parent width and center this element horizontally.
    
    Parameters:
    
    percent - percent 100 for 100%
  - fillParentWidth
```
public void fillParentWidth()
```
    Fill parent width.
  - fillParentHeight
```
public void fillParentHeight(int percent)
```
    Fill x percent of parent height and center this element vertically.
    
    Parameters:
    
    percent - percent 100 for 100%
  - fillParentHeight
```
public void fillParentHeight()
```
    Fill parent height.
  - fillParent
```
public void fillParent()
```
    Fill parent width and height.
  - fillParent
```
public void fillParent(int percent)
```
    Fill x percent of parents width and height.
    
    Parameters:
    
    percent - percent
  - fillParent
```
public void fillParent(int widthPercent,
                       int heightPercent)
```
    Fill widthPercent of parent width and heightPercent of parent height.
    
    Parameters:
    
    widthPercent - width percentage
    
    heightPercent - height percentage
  - setAutosizing
```
public void setAutosizing(boolean autosizing)
```
    Enable/disable autosizing.
    
    Parameters:
    
    autosizing - autosizing
  - noAutosize
```
public void noAutosize()
```
    Disable autosizing.
  - setX
```
public void setX(int x)
```
    Set x-coordinate of element relative to parent. Does not apply if element is added to containers that provide some own layout.
    
    Parameters:
    
    x - x-coordinate in pixel
  - setY
```
public void setY(int y)
```
    Set y-coordinate of element relative to parent. Does not apply if element is added to containers that provide some own layout.
    
    Parameters:
    
    y - y-coordinate in pixel
  - setZ
```
public void setZ(int z)
```
    Set z-coordinate of element. Elements are sorted by z-index when overlapping on the screen.
    
    Parameters:
    
    z - z-index
  - setPosition
```
public void setPosition(int x,
                        int y)
```
    Set position relative to parent.
    
    Parameters:
    
    x - x-coordinate in pixel
    
    y - y-coordinate in pixel
  - setWidth
```
public void setWidth(int width)
```
    Set width of element.
    
    Parameters:
    
    width - width in pixel
  - setHeight
```
public void setHeight(int height)
```
    Set height of element.
    
    Parameters:
    
    height - height in pixel
  - setWidth
```
public void setWidth(float width)
```
    Convenience version that casts to int!
    
    Parameters:
    
    width - width in pixel
  - setHeight
```
public void setHeight(float height)
```
    Convenience version that casts to int!
    
    Parameters:
    
    height - in pixel
  - setSize
```
public void setSize(int width,
                    int height)
```
    Set width and height of element.
    
    Parameters:
    
    width - width in pixel
    
    height - height in pixel
  - setFixedSize
```
public void setFixedSize(int width,
                         int height)
```
    Set size of element and disable autosizing.
    
    Parameters:
    
    width - width
    
    height - height
  - setMinWidth
```
public void setMinWidth(int minWidth)
```
    Set minimum width of element in pixel. Width of element will never be less than minWidth and therefore might be adjusted. Minimum width cannot be smaller than 1 and not greater than minWidth.
    
    Parameters:
    
    minWidth - minimum width in pixel
  - setMaxWidth
```
public void setMaxWidth(int maxWidth)
```
    Set maximum width of element in pixel. Width of element will never be greater than maxWidth. Default is 100000.
    
    Parameters:
    
    maxWidth - maximum width in pixel
  - setMinHeight
```
public void setMinHeight(int minHeight)
```
    Set minimum height of element in pixel. Height of element will never be less than minHeight and therefore might be adjusted. Minimum height cannot be smaller than 1 and not greater than maxHeight.
    
    Parameters:
    
    minHeight - minimum height in pixel
  - setMaxHeight
```
public void setMaxHeight(int maxHeight)
```
    Set maximum height of element in pixel. Height of element will never be greater than maxHeight. Default is 100000.
    
    Parameters:
    
    maxHeight - maximum height in pixel
  - setBackgroundColor
```
public void setBackgroundColor(int clr)
```
    Set the plain background color of the element. Actual displayed color can vary if the element is i.e. hovered over.
    
    Parameters:
    
    clr - integer rgb color
  - setForegroundColor
```
public void setForegroundColor(int clr)
```
    Set the foreground color (not really used anymore, except in slider and knob).
    
    Parameters:
    
    clr - integer rgb color
  - setHoverColor
```
public void setHoverColor(int clr)
```
    Background color when mouse hovers over this component.
    
    Parameters:
    
    clr - integer rgb color
  - setPressedColor
```
public void setPressedColor(int clr)
```
    Background color when mouse is pressed down on this component.
    
    Parameters:
    
    clr - integer rgb color
  - setBorderColor
```
public void setBorderColor(int clr)
```
    Color of elements border.
    
    Parameters:
    
    clr - integer rgb color
  - setBorderWidth
```
public void setBorderWidth(int borderWidth)
```
    Stroke width of the elements border.
    
    Parameters:
    
    borderWidth - border with in pixel
  - setBorderRadius
```
public void setBorderRadius(int borderRadius)
```
    Rounds the corners of the element. Negative values will be ignored.
    
    Parameters:
    
    borderRadius - border radius
  - setBorder
```
public void setBorder(int borderWidth,
                      int borderColor,
                      int borderRadius)
```
    Shorthand property for setting all border properties.
    
    Parameters:
    
    borderWidth - border width
    
    borderColor - border color
    
    borderRadius - border radius
  - setBorder
```
public void setBorder(int borderWidth,
                      int borderColor)
```
    Shorthand property for setting border width and color.
    
    Parameters:
    
    borderWidth - border width
    
    borderColor - border color
  - setCursor
```
public void setCursor(int cursor)
```
    Set the cursor displayed when mouse is over this element.
    
    Parameters:
    
    cursor - Integer between 0 and 11. Can use constants like ARROW, CROSS, HAND, MOVE, TEXT, or WAIT.
  - setImage
```
public void setImage(PImage image)
```
    Set the (background) image of the element. This is not implemented in all but in most classes. The image is copied!
    
    Parameters:
    
    image - PImage or PGraphics object.
  - setImageMode
```
public void setImageMode(Control.ImageMode imageMode)
```
    Set the background image filling mode. @see FILL, @see FIT @see FIT_INSIDE.
    
    Parameters:
    
    imageMode. - Use Control.FILL, Control.FIT or Control.FIT_INSIDE
  - setGradient
```
public void setGradient(int topColor,
                        int bottomColor)
```
    Set background to a vertical gradient between the two given colors. This removes the background image if set. At the moment, only vertical gradients are possible.
    
    Parameters:
    
    topColor - top gradient color
    
    bottomColor - bottom gradient color
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Set the enabled state of this element. If false it will not receive any events and be displayed in a different (mostly greyish) way.
    
    Parameters:
    
    enabled - enabled state
  - setVisible
```
public void setVisible(boolean visible)
```
    Set the visibility. Invisible elements will not be rendered and receive not events.
    
    Parameters:
    
    visible - visibility state
  - setVisibility
```
public void setVisibility(boolean visible)
```
    Just in case someone expects a "setVisibility" method instead of "setVisible".
    
    Parameters:
    
    visible - visibility state
  - setOpacity
```
public void setOpacity(double opacity)
```
    Set opacity (opposite of transparency), casts to float.
    
    Parameters:
    
    opacity - opacity from 0 (transparent) to 1 (opaque).
  - setOpacity
```
public void setOpacity(float opacity)
```
    Set opacity (opposite of transparency). Transparent elements are still clickable (like in html), even if the opacity is 0. Call setVisibility(false) or setEnabled(false) to prevent the element from receiving mouse events.
    
    Parameters:
    
    opacity - opacity from 0 (transparent) to 1 (opaque).
  - setMargin
```
public void setMargin(int all)
```
    Apply margins to all sides of the element. In FlowContainers and similar containers neighboring elements this determines the distance to neighbor elements and the parents bounds.
    
    Parameters:
    
    all - margin in pixel
  - setMargin
```
public void setMargin(int top_bottom,
                      int left_right)
```
    Apply same margins to both top/bottom and left/right.
    
    Parameters:
    
    top_bottom - top and bottom margin
    
    left_right - left and right margin
  - setMargin
```
public void setMargin(int top,
                      int right,
                      int bottom,
                      int left)
```
    Set individual top, right, bottom and left margins.
    
    Parameters:
    
    top - top margin in pixel
    
    right - right margin in pixel
    
    bottom - bottom margin in pixel
    
    left - left margin in pixel
  - setMarginTop
```
public void setMarginTop(int top)
```
  - setMarginRight
```
public void setMarginRight(int right)
```
  - setMarginBottom
```
public void setMarginBottom(int bottom)
```
  - setMarginLeft
```
public void setMarginLeft(int left)
```
  - setPadding
```
public void setPadding(int all)
```
    Apply same padding to all sides
    
    Parameters:
    
    all - padding in pixel
  - setPadding
```
public void setPadding(int top_bottom,
                       int left_right)
```
  - setPadding
```
public void setPadding(int top,
                       int right,
                       int bottom,
                       int left)
```
    Apply individual padding to all sides of the element. Padding will create space inside the element between borders and content.
    
    Parameters:
    
    top - top padding in pixel
    
    right - right padding in pixel
    
    bottom - bottom padding in pixel
    
    left - left padding in pixel
  - setPaddingTop
```
public void setPaddingTop(int top)
```
  - setPaddingRight
```
public void setPaddingRight(int right)
```
  - setPaddingBottom
```
public void setPaddingBottom(int bottom)
```
  - setPaddingLeft
```
public void setPaddingLeft(int left)
```
  - getParent
```
public Control getParent()
```
  - getX
```
public int getX()
```
  - getY
```
public int getY()
```
  - getZ
```
public int getZ()
```
  - getWidth
```
public int getWidth()
```
  - getMinWidth
```
public int getMinWidth()
```
  - getMaxWidth
```
public int getMaxWidth()
```
  - getHeight
```
public int getHeight()
```
  - getMinHeight
```
public int getMinHeight()
```
  - getMaxHeight
```
public int getMaxHeight()
```
  - getAvailableWidth
```
public int getAvailableWidth()
```
    Get available content width subtracting paddings.
    
    Returns:
    
    available width
  - getAvailableHeight
```
public int getAvailableHeight()
```
    Get available content height subtracting paddings.
    
    Returns:
    
    available height
  - getBackgroundColor
```
public int getBackgroundColor()
```
  - getForegroundColor
```
public int getForegroundColor()
```
  - getHoverColor
```
public int getHoverColor()
```
  - getPressedColor
```
public int getPressedColor()
```
  - getBorderColor
```
public int getBorderColor()
```
  - getBorderWidth
```
public int getBorderWidth()
```
  - getBorderRadius
```
public int getBorderRadius()
```
  - getCursor
```
public int getCursor()
```
  - getImage
```
public PImage getImage()
```
  - isEnabled
```
public boolean isEnabled()
```
  - isVisible
```
public boolean isVisible()
```
  - getOpacity
```
public float getOpacity()
```
  - isFocusable
```
public boolean isFocusable()
```
  - isFocused
```
public boolean isFocused()
```
  - getMarginTop
```
public int getMarginTop()
```
  - getMarginRight
```
public int getMarginRight()
```
  - getMarginBottom
```
public int getMarginBottom()
```
  - getMarginLeft
```
public int getMarginLeft()
```
  - getPaddingTop
```
public int getPaddingTop()
```
  - getPaddingRight
```
public int getPaddingRight()
```
  - getPaddingBottom
```
public int getPaddingBottom()
```
  - getPaddingLeft
```
public int getPaddingLeft()
```
  - copyStyle
```
public void copyStyle(Control source)
```
    Enable user of the library to adopt a set of visual properties from another element. @see copyStyle(Control, long).
    
    Parameters:
    
    source - element to adopt properties from.
  - copyStyle
```
public void copyStyle(Control source,
                      long attribs)
```
    Enable user of the library to adopt a set of visual style properties from another element. Call copyStyle(Control, attribs) to read given attributes (separated by bitwise OR) from given element c: myElement.copyStyle(otherElement, PADDING_LEFT | MARGIN_BOTTOM, FOREGROUND_COLOR);
    
    Options are: PADDING_LEFT, PADDING_RIGHT, PADDING_TOP, PADDING_BOTTOM, MARGIN_LEFT, MARGIN_RIGHT, MARGIN_TOP, MARGIN_BOTTOM, BACKGROUND_COLOR, HOVER_COLOR, PRESSED_COLOR, FOREGROUND_COLOR, BORDER_WIDTH, BORDER_RADIUS, BORDER_COLOR, OPACITY,
    
    Only if source and target have text properties: TEXT_COLOR, TEXT_ALIGN, TEXT_ALIGN_Y, FONT_SIZE, LINE_HEIGHT.
    
    There some shortcuts to include several properties, like ALL, COLORS, MARGIN (all margins), PADDING (all paddings), SPACING (all margins and paddings), BACKGROUND_COLORS (background-, hover-, and pressedColor), BORDER (border-width, -color and -radius), TEXT_PROPERTIES (all text properties).
    
    Parameters:
    
    source - element to adopt properties from.
    
    attribs - bitwise OR added attributes
  - doForAll
```
@SafeVarargs
public static <T> void doForAll(Control.Setter<T> setter,
                                              T... elements)
```
    (A bit more advanced!) Do a given method for all given objects (not necessarily UI elements). The idea is to apply setters to several elements without boilerplate code.
    You can pass an instance of Control.Setter<>, override its run() method and then pass any number of elements.
    You need to specify an object class, i.e. Control if you only need to use methods from Control or Textbox, if you would like to use setters individual to Textbox.
    Example:
```
 Control.doForAll(new Control.Setter<Control>() {
     @Override
     public void run(Control c) {
         c.setBackgroundColor(color(0)); 
     }
 }, myButton, myLabel, myTextbox);
 
```
    or:
```
 Control.doForAll(new Control.Setter<Container>() {
     @Override
     public void run(Container c) {
         c.fitContent(); 
     }
 }, myContainer, myHScrollContainer, myScrollArea, myFlowContainer);
 
```
    Type Parameters:
    
    T - type of object
    
    Parameters:
    
    setter - a setter (need to override the run() method and specify template type)
    
    elements - arbitrary number of elements that are of the given template type
  - animate
```
public void animate(java.lang.String attribute,
                    float aimedValue,
                    double milliseconds)
```
    Create a transition animation for a property of this Component. The Frame will deal with changing this property in appropriate steps to create the effect. I.e. write: myObject.animate("x", 50, 500); to change the x-coordinate of myObject to 50 within half a second. Or myObject.animate("opacity", 0, 100); to create a fade-out transition.
    
    Parameters:
    
    attribute - name of attribute to animate
    
    aimedValue - final value for the attribute
    
    milliseconds - time for animation in milliseconds
  - setMouseListener
```
public boolean setMouseListener(java.lang.String type,
                                java.lang.String methodName)
```
    Set a mouse listener. The type can be "press", "release", "enter", "exit, "move", "drag" and "wheel". Each Component allows one listener per type. The given method can be implemented without arguments or with MouseEvent as parameter. If it is defined in another class than in the main PApplet scope use the overloaded method setMouseListener(String, String, Object) that allows passing a target object.
    
    Parameters:
    
    type - String for event type
    
    methodName - Name of method to invoke
    
    Returns:
    
    false if type is invalid, method is not accessible or a listener has already been registered for this type. Returns true if successful.
  - setMouseListener
```
public boolean setMouseListener(java.lang.String type,
                                java.lang.String methodName,
                                java.lang.Object target)
```
    Allows to pass a target object where the given method is declared.
    
    Parameters:
    
    type - String for event type
    
    methodName - name of callback method
    
    target - Object where the callback method is declared.
    
    Returns:
    
    false if type is invalid, method is not accessible or a listener has already been registered for this type. Returns true if successful.
    
    See Also:
    
    setMouseListener(String, String)
  - setMouseListener
```
public void setMouseListener(java.lang.String type,
                             Control.Predicate lambda)
```
    Set a mouse listener in form of a lambda expression. For possible types see setMouseListener(String, String). Event parameters: none
    
    Parameters:
    
    type - see setMouseListener(String, String)
    
    lambda - lambda expression
  - setMouseListener
```
public void setMouseListener(java.lang.String type,
                             Control.Predicate1<MouseEvent> lambda)
```
    Set a mouse listener in form of a lambda expression with a MouseEvent as argument. For possible types see setMouseListener(String, String). Event parameters: MouseEvent
    
    Parameters:
    
    type - see setMouseListener(String, String)
    
    lambda - lambda expression with a MouseEvent as argument.
  - removeMouseListener
```
public void removeMouseListener(java.lang.String type)
```
    Remove a mouse listener for given type if one has already been set up.
    
    Parameters:
    
    type - event type.
  - setResizeListener
```
public void setResizeListener(java.lang.String methodName,
                              java.lang.Object target)
```
    Set a resize listener that fires each time the element is resized by anchor resizing. Event arguments: the Control that is resized
    
    Parameters:
    
    methodName - name of callback method
    
    target - Object where the callback method is declared.
  - setResizeListener
```
public void setResizeListener(java.lang.String methodName)
```
  - setResizeListener
```
public void setResizeListener(Control.Predicate1<Control> lambda)
```
    Set a lambda focus listener with a Control as parameter that fires each time the element is resized by anchor resizing. Event arguments: the Control that is resized
    
    Parameters:
    
    lambda - lambda expression with Control parameter
  - setResizeListener
```
public void setResizeListener(Control.Predicate lambda)
```
    Set a lambda focus listener that fires each time the element is resized by anchor resizing. Event arguments: none
    
    Parameters:
    
    lambda - lambda expression
  - removeResizeListener
```
public void removeResizeListener()
```
  - setFocusListener
```
public void setFocusListener(java.lang.String methodName,
                             java.lang.Object target)
```
    Set a focus listener that fires when the element gets focus (through mouse click or programmatically). Event arguments: The Control that got focus
    
    Parameters:
    
    methodName - name of callback method
    
    target - Object where the callback method is declared.
  - setFocusListener
```
public void setFocusListener(java.lang.String methodName)
```
  - setFocusListener
```
public void setFocusListener(Control.Predicate1<Control> lambda)
```
    Set a lambda focus listener with a Control as parameter that fires when the element gets focus (through mouse click, programmatically). Event arguments: The Control that got focus
    
    Parameters:
    
    lambda - lambda expression with Control parameter
  - setFocusListener
```
public void setFocusListener(Control.Predicate lambda)
```
    Set a lambda focus listener that fires when the element gets focus (through mouse click, programmatically). Event arguments: none
    
    Parameters:
    
    lambda - lambda expression
  - removeFocusListener
```
public void removeFocusListener()
```
  - stopPropagation
```
public static void stopPropagation()
```
    Stop mouse event propagation. If called then no Components lower or at the same level in the Container hierachy will receive the currently processed mouse event.
  - isPropagationStopped
```
public static boolean isPropagationStopped()
```
    Check if the mouse event propagation has been stopped.
    
    Returns:
    
    propagation stop state
  - relativeCoordsAreWithin
```
public boolean relativeCoordsAreWithin(int x,
                                       int y)
```
    Check if given coordinates (need to be relative to parent) are within this element (without constraining to parents bounds).
    
    Parameters:
    
    x - x coordinate relative to parent origin
    
    y - y coordinate relative to parent origin
    
    Returns:
    
    are coordintes within
  - getOffsetXToParent
```
public int getOffsetXToParent()
```
    Get x coordinate of left side relative to parent.
    
    Returns:
    
    relative x
  - getOffsetYToParent
```
public int getOffsetYToParent()
```
    Get y coordinate of left side relative to parent.
    
    Returns:
    
    relative y
  - getOffsetXToWindow
```
public int getOffsetXToWindow()
```
    Get x coordinate of left side relative to window.
    
    Returns:
    
    absolute x
  - getOffsetYToWindow
```
public int getOffsetYToWindow()
```
    Get x coordinate of left side relative to window.
    
    Returns:
    
    absolute y
  - getVersionString
```
public static java.lang.String getVersionString()
```
    Get guiSET version. I really hope I'll always remember syncing this.
    
    Returns:
    
    version

Class Control

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

FILL

FIT

FIT_INSIDE

BUFFERED_RENDERING

UNBUFFERED_RENDERING

defaultRenderingMethod

ANCHOR_INACTIVE

PERCENTAGE_MODE

PIXEL_MODE

AUTOSIZE_NONE

AUTOSIZE_WIDTH

AUTOSIZE_HEIGHT

AUTOSIZE_BOTH

PADDING_LEFT

PADDING_RIGHT

PADDING_TOP

PADDING_BOTTOM

PADDING

MARGIN_LEFT

MARGIN_RIGHT

MARGIN_TOP

MARGIN_BOTTOM

MARGIN

BACKGROUND_COLOR

HOVER_COLOR

PRESSED_COLOR

BACKGROUND_COLORS

FOREGROUND_COLOR

BORDER_WIDTH

BORDER_COLOR

BORDER_RADIUS

BORDER

OPACITY

TEXT_COLOR

FONT_SIZE

TEXT_ALIGN

TEXT_ALIGN_Y

LINE_HEIGHT

TEXT_PROPERTIES

COLORS

SPACING

ALL

Constructor Detail

Control

Method Detail

focus

blur

unfocus

setBoxShadow

removeBoxShadow

forceRepaint

setAnchor

setAnchors

setPixelAnchor

setPixelAnchors

setPercentageAnchor

setPercentageAnchors

getAnchorMode

getAnchorValue

addAutoAnchors

removeAnchor

fillParentWidth

fillParentWidth

fillParentHeight

fillParentHeight

fillParent

fillParent

fillParent

setAutosizing

noAutosize

setX

setY