Class AwtUIBand

public class AwtUIBand extends AwtUIControl
{
  // Constructors
  public AwtUIBand();
  public AwtUIBand(String name);
  public AwtUIBand(String name, int style);

  // Methods
  public IUIComponent getBase();
  public int getStyle();
  public boolean isBreak();
  public boolean isDragBreak();
  public void setBreak(boolean on);
  public void setDragBreak(boolean on);
  public void setStyle(int style);
}

This class implements the functionality of a UIBand object in an AWT-based control. An AwtUIBand control is an AwtUIHost component whose associated root container holds a UIBand object. By hosting this object, an AwtUIBand control integrates AFC with AWT. Although an AwtUIBand control is fully compatible with AWT, a UIBand control is optimized for performance and size.

Panel
  |
  +--AwtUIHost
    |
    +--AwtUIControl
      |
      +--AwtUIBand

Constructors

AwtUIBand

public AwtUIBand();

Creates an AWT-based band control with no content.

AwtUIBand

public AwtUIBand(String name);

Creates an AWT-based band control with the specified text.

Parameter	Description
name	The text to be displayed on the band control.

AwtUIBand

public AwtUIBand(String name, int style);

Creates an AWT-based band control with the specified text and style.

Parameter	Description
name	The text to be displayed on the band control.
style	The style of the band control. Specify any bitwise combination of UIBand.BREAK and UIBand.DRAGBREAK.

Exceptions:

IllegalArgumentException if an undefined style was specified.

Methods

getBase

public IUIComponent getBase();

Retrieves the UI component that the control is based on.

Return Value:

Returns the UIBand object associated with the band control.

Remarks:

When the AWT-based band control is first created, it is associated with a UIBand object.

getStyle

public int getStyle();

Retrieves the current style of the control.

Return Value:

Returns an integer containing the current style setting. For a list of possible values, see setStyle.

isBreak

public boolean isBreak();

Determines whether the BREAK attribute is set in the control's style.

Return Value:

Returns true if the style includes BREAK; otherwise, returns false.

isDragBreak

public boolean isDragBreak();

Determines whether the DRAGBREAK attribute is set in the control's style.

Return Value:

Returns true if the style includes DRAGBREAK; otherwise, returns false.

setBreak

public void setBreak(boolean on);

Sets or clears the BREAK attribute in the control's style.

Return Value:

No return value.

Parameter	Description
on	If true, the BREAK attribute is set; otherwise, it is cleared.

setDragBreak

public void setDragBreak(boolean on);

Sets or clears the DRAGBREAK attribute in the control's style.

Return Value:

No return value.

Parameter	Description
on	If true, the DRAGBREAK attribute is set; otherwise, it is cleared.

setStyle

public void setStyle(int style);

Sets the current style of the control.

Return Value:

No return value.

Parameter	Description
style	The style of the band control. Specify any bitwise combination of UIBand.BREAK and UIBand.DRAGBREAK.

Exceptions:

IllegalArgumentException if an undefined style was specified.