guiSET.core

Class Container

java.lang.Object

guiSET.core.Control

guiSET.core.TextBased

guiSET.core.Container

Direct Known Subclasses:

FlowContainer, Frame, HFlowContainer, ScrollArea, VFlowContainer

public class Container
extends TextBased

Base class for all containers. Containers group items and can be nested to create complex graphics structures.

Author:

Mc-Zen

Nested Class Summary

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 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
Container() Default constructor sets width and height to 100
Container(int width, int height)

Method Summary

Modifier and Type	Method and Description
void	add(Control... items) Add items to Container.
void	clear() Remove all items.
void	fitContent() Resize container once so it fits its content.
Control	getItem(int index) Get item in item list at given index.
Control[]	getItems() Retrieve all items as Control array.
int	getNumItems() Get number of items.
int	indexOf(Control item) Get list index of given item.
void	insert(int position, Control... items) Insert items at given index position.
boolean	remove(Control item) Remove a specific item from item list.
Control	remove(int index) Remove item at position in item list.
void	sortItems(java.util.Comparator<Control> comp) Sort items providing a Comparator.
java.util.ArrayList<Control>	traceAbsoluteCoordinates(int x, int y) Get a list of arbitrarly nested child elements that given coordinates go through, ordered by layer on the screen.
java.util.ArrayList<Control>	traceRelativeCoordinates(int x, int y) Get a list of arbitrarly nested child elements that given coordinates go through, ordered by layer on the screen.

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

addAutoAnchors, 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, getOffsetXToWindow, getOffsetYToParent, getOffsetYToWindow, getOpacity, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPressedColor, getVersionString, getWidth, getX, getY, getZ, isEnabled, isFocusable, isFocused, isPropagationStopped, isVisible, noAutosize, relativeCoordsAreWithin, removeAnchor, removeBoxShadow, removeFocusListener, removeMouseListener, removeResizeListener, setAnchor, setAnchors, setAutosizing, setBackgroundColor, setBorder, setBorder, setBorderColor, setBorderRadius, setBorderWidth, setBoxShadow, setCursor, setEnabled, setFixedSize, setFocusListener, setFocusListener, setFocusListener, setFocusListener, setGradient, setHeight, 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, setWidth, setX, setY, setZ, stopPropagation, unfocus

Methods inherited from class java.lang.Object

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

Constructor Detail

Container

public Container()

Default constructor sets width and height to 100

Container

public Container(int width,
                 int height)

Method Detail

add

public void add(Control... items)

Add items to Container. Containers that don't layout their items automatically like i.e. VFlowContainer or VScrollContainer sort them by z-index!

Parameters:

items - arbitrary number of items.

insert

public void insert(int position,
                   Control... items)

Insert items at given index position.

Parameters:

position - index to insert items into list.

items - arbitrary number of items.

clear

public void clear()

Remove all items.

remove

public Control remove(int index)

Remove item at position in item list. Throws error if index is bad.

Parameters:

index - position

Returns:

returns the removed item

remove

public boolean remove(Control item)

Remove a specific item from item list.

Parameters:

item - item to remove.

Returns:

true if the item has actually been removed

indexOf

public int indexOf(Control item)

Get list index of given item. Returns -1 if item is no child of this container.

Parameters:

item - item to get index to

Returns:

index

getItems

public Control[] getItems()

Retrieve all items as Control array.

Returns:

array of items

getItem

public Control getItem(int index)

Get item in item list at given index. Throws error if index exceeds list length.

Parameters:

index - index of requested item

Returns:

item

getNumItems

public int getNumItems()

Get number of items.

Returns:

number of items

sortItems

public void sortItems(java.util.Comparator<Control> comp)

Sort items providing a Comparator.

Parameters:

comp - Comparator

fitContent

public void fitContent()

Resize container once so it fits its content.

traceRelativeCoordinates

public java.util.ArrayList<Control> traceRelativeCoordinates(int x,
                                                             int y)

Get a list of arbitrarly nested child elements that given coordinates go through, ordered by layer on the screen. This version takes relative coordinates of this object. Invisible and disabled elements are ignored.

Parameters:

x - x coordinate on this element

y - y coordinate on this element

Returns:

list of traces elements

traceAbsoluteCoordinates

public java.util.ArrayList<Control> traceAbsoluteCoordinates(int x,
                                                             int y)

Get a list of arbitrarly nested child elements that given coordinates go through, ordered by layer on the screen. This version takes absolute window coordinates. Invisible and disabled elements are ignored.

Parameters:

x - absolute x window coordinate

y - absolute y window coordinate

Returns:

list of traces elements