Interface IUIBand

public interface IUIBand
{
  // Methods
  public boolean getBreak();
  public boolean getDragBreak();
  public int getRestoredWidth();
  public void setBreak(boolean on);
  public void setDragBreak(boolean on);
  public void setRestoredWidth(int width);
}

This interface is used to retrieve and set properties of band objects. UIBand implements IUIBand.

Methods

getBreak

public boolean getBreak();

Determines whether the band begins a new row.

Return Value:

Returns true if the band begins a new row. If the method returns false, the band continues on the current row.

getDragBreak

public boolean getDragBreak();

Determines whether the band begins a new row when there isn't sufficient space for it on the current row.

Return Value:

Returns true if the band begins a new row. If the method returns false, the band continues on the current row.

getRestoredWidth

public int getRestoredWidth();

Retrieves the width that the object will be restored to.

Return Value:

Returns the width (in pixels) of the restored object.

setBreak

public void setBreak(boolean on);

Sets or clears the band's break state.

Return Value:

No return value.

Parameter	Description
on	Set to true if the band begins a new row.

setDragBreak

public void setDragBreak(boolean on);

Sets or clears the band's drag break state.

Return Value:

No return value.

Parameter	Description
on	Set to true if the band begins a new row due to lack of space on the current row. there isn't sufficient space in

Remarks:

This method is called by the parent container when laying out its bands, and is not typically called by an application. Use the setBreak(boolean) method to start a band on a new row (or the same row).

setRestoredWidth

public void setRestoredWidth(int width);

Sets the width that the object will be restored to.

Return Value:

No return value.

Parameter	Description
width	The width (in pixels) of the restored object.