net.rim.device.api.ui
Class XYEdges

java.lang.Object
  net.rim.device.api.ui.XYEdges

public final class XYEdges
extends Object

Used to describe padding, borders, and margins.

Since:

BlackBerry API 4.0.0

Field Summary
int	bottom Bottom edge.
int	left Left edge.
int	right Right edge.
int	top Top edge.

Constructor Summary

XYEdges()
Creates a new, empty XYEdges instance.

XYEdges(int top, int right, int bottom, int left)
Creates a new XYEdges instance with provided borders.

Method Summary
boolean	isEmpty() Determins whether or not the entire edge region is zero width.
void	set(int top, int right, int bottom, int left) Sets new values for all four edges.

Methods inherited from class java.lang.Object

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

Field Detail

bottom

public int bottom

Bottom edge.

Since:

BlackBerry API 4.0.0

left

public int left

Left edge.

Since:

BlackBerry API 4.0.0

right

public int right

Right edge.

Since:

BlackBerry API 4.0.0

top

public int top

Top edge.

Since:

BlackBerry API 4.0.0

Constructor Detail

XYEdges

public XYEdges()

Creates a new, empty XYEdges instance.

Equivalent to invoking XYEdges(0,0,0,0).

Since:

BlackBerry API 4.0.0

XYEdges

public XYEdges(int top,
               int right,
               int bottom,
               int left)

Creates a new XYEdges instance with provided borders.

Parameters:

top - Top edge.

right - Right edge.

bottom - Bottom edge.

left - Left edge.

Since:

BlackBerry API 4.0.0

Method Detail

isEmpty

public boolean isEmpty()

Determins whether or not the entire edge region is zero width.

Returns:

True if all edges are set to zero; otherwise, false.

Since:

BlackBerry API 4.0.0

set

public void set(int top,
                int right,
                int bottom,
                int left)

Sets new values for all four edges.

Parameters:

top - New top edge value.

right - New right edge value.

bottom - New bottom edge value.

left - New left edge value.

Since:

BlackBerry API 4.0.0