sk.upjs.jpaz2

Class JPAZWindow

java.lang.Object

sk.upjs.jpaz2.JPAZWindow

public class JPAZWindow
extends Object

JPAZWindow represents a window that is able to display a pane. It is aimed to be used as a main container to display panes.

Constructor Summary

Constructors

Constructor and Description
JPAZWindow() Constructs new window for displaying a pane.
JPAZWindow(Pane pane) Constructs new window for displaying a pane.
JPAZWindow(Pane pane, boolean alignMode) Constructs new window for displaying a pane.

Method Summary

Modifier and Type	Method and Description
void	bindTo(Pane pane) Binds the content of this window to a pane.
void	bindTo(Pane pane, boolean align) Binds the content of this window to a pane.
void	center() Centers the window.
int	getHeight() Returns the height of the window.
Pane	getPane() Returns the pane that is bound (displayed) to this window.
String	getTitle() Returns the title of the window (frame).
int	getWidth() Returns the width of the window.
int	getX() Returns the X-coordinate of the top-left corner of the window.
int	getY() Returns the Y-coordinate of the top-left corner of the window.
boolean	isAlignMode() Returns whether the bound pane is aligned to the window.
boolean	isResizable() Returns whether the window (frame) is resizable.
void	rebindWithEffect(Pane pane, boolean align, TransitionEffect transitionEffect, long duration) Binds the content of this window to another pane with transition effect.
void	rebindWithEffect(Pane pane, TransitionEffect transitionEffect, long duration) Binds the content of this window to another pane with transition effect.
void	setAlignMode(boolean alignMode) Sets whether the bound pane is aligned to the window.
void	setHeight(int height) Sets the height of the window.
void	setIconImage(Image image) Sets the icon of the window.
void	setIconImage(ImageShape imageShape) Sets the icon of the window.
void	setLocation(int x, int y) Sets the location of the top-left corner of the window.
void	setPane(Pane pane) Sets the pane that is bound to this window.
void	setResizable(boolean resizable) Sets whether the window (frame) is resizable.
void	setSize(int width, int height) Sets size of the window.
void	setTitle(String title) Sets the title of the window.
void	setWidth(int width) Sets the width of the window.
void	setX(int x) Sets the X-coordinate of the top-left corner of the window.
void	setY(int y) Sets the Y-coordinate of the top-left corner of the window.

Methods inherited from class java.lang.Object

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

Constructor Detail

JPAZWindow

public JPAZWindow()

Constructs new window for displaying a pane.

JPAZWindow

public JPAZWindow(Pane pane)

Constructs new window for displaying a pane. The pane is aligned to the window (frame).

Parameters:

pane - the pane to be displayed in this window.

JPAZWindow

public JPAZWindow(Pane pane,
                  boolean alignMode)

Constructs new window for displaying a pane.

Parameters:

pane - the pane to be displayed in this window.

alignMode - a boolean, true for aligning the pane is aligned to the window (frame).

Method Detail

bindTo

public void bindTo(Pane pane)

Binds the content of this window to a pane.

Parameters:

pane - the pane to be displayed in this window (frame).

bindTo

public void bindTo(Pane pane,
                   boolean align)

Binds the content of this window to a pane.

Parameters:

pane - the pane to be bound to this window.

align - a boolean, true for aligning the bound pane to the window.

rebindWithEffect

public void rebindWithEffect(Pane pane,
                             boolean align,
                             TransitionEffect transitionEffect,
                             long duration)

Binds the content of this window to another pane with transition effect.

Parameters:

pane - the pane to be bound to this window.

align - a boolean, true for aligning the bound pane to the window.

transitionEffect - the transition effect to be applied.

duration - the duration of the transition in milliseconds.

rebindWithEffect

public void rebindWithEffect(Pane pane,
                             TransitionEffect transitionEffect,
                             long duration)

Binds the content of this window to another pane with transition effect.

Parameters:

pane - the pane to be bound to this window.

transitionEffect - the transition effect to be applied.

duration - the duration of the transition in milliseconds.

getPane

public Pane getPane()

Returns the pane that is bound (displayed) to this window.

Returns:

the bound pane.

setPane

public void setPane(Pane pane)

Sets the pane that is bound to this window.

Parameters:

pane - the pane to be bound to this window.

isAlignMode

public boolean isAlignMode()

Returns whether the bound pane is aligned to the window.

Returns:

true, if the bound pane is aligned to the window, false otherwise.

setAlignMode

public void setAlignMode(boolean alignMode)

Sets whether the bound pane is aligned to the window.

Parameters:

alignMode - true, if the bound pane is aligned to the window, false otherwise.

getTitle

public String getTitle()

Returns the title of the window (frame).

Returns:

the title of the window.

setTitle

public void setTitle(String title)

Sets the title of the window.

Parameters:

title - the desired title of the window.

getWidth

public int getWidth()

Returns the width of the window.

Returns:

the width of the window.

setWidth

public void setWidth(int width)

Sets the width of the window.

Parameters:

width - the desired width of the window.

getHeight

public int getHeight()

Returns the height of the window.

Returns:

the height of the window.

setHeight

public void setHeight(int height)

Sets the height of the window.

Parameters:

height - the desired height of the window.

setSize

public void setSize(int width,
                    int height)

Sets size of the window.

Parameters:

width - the desired width of the window.

height - the desired height of the window.

getX

public int getX()

Returns the X-coordinate of the top-left corner of the window.

Returns:

the X-coordinate of the top-left corner of the window.

setX

public void setX(int x)

Sets the X-coordinate of the top-left corner of the window.

Parameters:

x - the desired X-coordinate of the top-left corner of the window.

getY

public int getY()

Returns the Y-coordinate of the top-left corner of the window.

Returns:

the Y-coordinate of the top-left corner of the window.

setY

public void setY(int y)

Sets the Y-coordinate of the top-left corner of the window.

Parameters:

y - the desired Y-coordinate of the top-left corner of the window.

setLocation

public void setLocation(int x,
                        int y)

Sets the location of the top-left corner of the window.

Parameters:

x - the desired X-coordinate of the top-left corner of the window.

y - the desired Y-coordinate of the top-left corner of the window.

center

public void center()

Centers the window.

isResizable

public boolean isResizable()

Returns whether the window (frame) is resizable.

Returns:

true, if the window is resizable.

setResizable

public void setResizable(boolean resizable)

Sets whether the window (frame) is resizable.

Parameters:

resizable - a boolean, true if the window is resizable, false otherwise.

setIconImage

public void setIconImage(Image image)

Sets the icon of the window.

Parameters:

image - the desired image to be shown as an icon of the window.

setIconImage

public void setIconImage(ImageShape imageShape)

Sets the icon of the window.

Parameters:

imageShape - the desired image shape to be shown as an icon of the window. A frame with index 0 of the view with index 0 will be used.