com.lukflug.panelstudio

Class Context

java.lang.Object

com.lukflug.panelstudio.Context

public final class Context
extends java.lang.Object

A class for the communication between a component and its parent.

Constructor Summary

Constructors

Constructor and Description
Context(Context context, int left, int right, int offset, boolean focus, boolean onTop) Constructor that should be used when a parent is calling a method by the child.
Context(Interface inter, int width, java.awt.Point position, boolean focus, boolean onTop) Constructor that should be used by the root parent (i.e.

Method Summary

Modifier and Type	Method and Description
boolean	focusReleased() Returns focusOverride.
boolean	foucsRequested() Returns focusRequested.
java.lang.String	getDescription() Get the description set by the child.
Interface	getInterface() Returns the current Interface.
java.awt.Point	getPos() Returns the component position.
java.awt.Rectangle	getRect() Get rectangle indicating component position.
java.awt.Dimension	getSize() Returns the component size.
boolean	hasFocus() Returns the focus state of the parent.
boolean	isClicked() Get mouse click state.
boolean	isHovered() Get mouse hover state.
boolean	onTop() Check if component is the highest at cursor position.
void	releaseFocus() Reverses requestFocus() and ask parent not to request focus.
void	requestFocus() Used to indicate to the parent that the current component has to have focus within the parent.
void	setDescription(java.lang.String description) Set the description when rendering.
void	setHeight(int height) Sets the height of the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(Context context,
               int left,
               int right,
               int offset,
               boolean focus,
               boolean onTop)

Constructor that should be used when a parent is calling a method by the child. inter and onTop are inherited without modification.

Parameters:

context - the context of the parent

left - the left horizontal border for the child

right - the right horizontal border for the child

offset - the vertical position of the child relative to the parent's position

focus - focus state of the parent

onTop - whether component is in the front

Context

public Context(Interface inter,
               int width,
               java.awt.Point position,
               boolean focus,
               boolean onTop)

Constructor that should be used by the root parent (i.e. ClickGUI).

Parameters:

inter - the current Interface

width - the width of the component

position - the position of the component

focus - set to false, to disable the component from having focus

onTop - set to false, if a component is above another component at the current cursor position

Method Detail

getInterface

public Interface getInterface()

Returns the current Interface.

Returns:

the current Interface

getSize

public java.awt.Dimension getSize()

Returns the component size.

Returns:

the component size

setHeight

public void setHeight(int height)

Sets the height of the component.

Parameters:

height - the component's height

getPos

public java.awt.Point getPos()

Returns the component position.

Returns:

the component position

hasFocus

public boolean hasFocus()

Returns the focus state of the parent.

Returns:

the focus state of the parent

onTop

public boolean onTop()

Check if component is the highest at cursor position.

Returns:

set to false, if another component is above this component at the current mouse cursor position

requestFocus

public void requestFocus()

Used to indicate to the parent that the current component has to have focus within the parent.

releaseFocus

public void releaseFocus()

Reverses requestFocus() and ask parent not to request focus.

foucsRequested

public boolean foucsRequested()

Returns focusRequested.

Returns:

whether the child is requesting focus.

focusReleased

public boolean focusReleased()

Returns focusOverride.

Returns:

whether the parent may request focus.

isHovered

public boolean isHovered()

Get mouse hover state.

Returns:

set to true, if mouse is hovering and component isn't below another one

isClicked

public boolean isClicked()

Get mouse click state.

Returns:

set to true, if isHovered() is true and the left mouse button is clicked

getRect

public java.awt.Rectangle getRect()

Get rectangle indicating component position.

Returns:

construct a rectangle out of the current component position and size

getDescription

public java.lang.String getDescription()

Get the description set by the child.

Returns:

the current description

setDescription

public void setDescription(java.lang.String description)

Set the description when rendering.

Parameters:

description - the new description