Style Intelligence v12.0

inetsoft.report.painter
Class BooleanPresenter

java.lang.Object
  extended by inetsoft.report.painter.BooleanPresenter
All Implemented Interfaces:
Presenter, Serializable

public class BooleanPresenter
extends Object
implements Presenter

The BooleanPresenter can be used to present the value of a boolean as two different icons. By default, a check mark is used to present the TRUE value, and an empty box is used to present the FALSE value. The icon can be changed by supplying the image explicitly. This is normally used in a table to display boolean values as check marks.

See Also:
Serialized Form

Constructor Summary
BooleanPresenter()
          Create a default boolean presenter.
BooleanPresenter(Image true_image, Image false_image)
          Create a boolean presenter with specified images.
 
Method Summary
 Color getBackground()
          Get the background.
 String getDisplayName()
          Get the display name of this presenter.
 Dimension getPreferredSize(Object v)
          Calculate the preferred size of the object representation.
 boolean isFill()
          Check if this presenter should always fill the entire area of a cell.
 boolean isPresenterOf(Class type)
          Check if the presenter can handle this type of objects.
 boolean isPresenterOf(Object obj)
          Check if the presenter can handle this particular object.
 boolean isRawDataRequired()
          Determine if this Presenter requires raw (unformatted) data.
 void paint(Graphics g, Object v, int x, int y, int w, int h)
          Paint the value.
 void setBackground(Color bg)
          Set the background.
 void setFont(Font font)
          Set the font to use for this presenter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BooleanPresenter

public BooleanPresenter()
Create a default boolean presenter.


BooleanPresenter

public BooleanPresenter(Image true_image,
                        Image false_image)
Create a boolean presenter with specified images.

Parameters:
true_image - icon for TRUE.
false_image - icon for FALSE.
Method Detail

paint

public void paint(Graphics g,
                  Object v,
                  int x,
                  int y,
                  int w,
                  int h)
Paint the value.

Specified by:
paint in interface Presenter
Parameters:
g - graphical context.
v - object value.
x - x coordinate of the left edge of the paint area.
y - y coordinate of the upper edge of the paint area.
w - area width.
h - area height.

getPreferredSize

public Dimension getPreferredSize(Object v)
Calculate the preferred size of the object representation.

Specified by:
getPreferredSize in interface Presenter
Parameters:
v - object value.
Returns:
preferred size.

isPresenterOf

public boolean isPresenterOf(Class type)
Check if the presenter can handle this type of objects.

Specified by:
isPresenterOf in interface Presenter
Parameters:
type - object type.
Returns:
true if the presenter can handle this type.

isPresenterOf

public boolean isPresenterOf(Object obj)
Check if the presenter can handle this particular object. Normally a presenter handles a class of objects, which is checked by the isPresenterOf(Class) method. If this presenter does not care about the value in the object, it can just call the isPresenterOf() with the class of the object, e.g.
   if(type == null) {
      return false;
   }
   return isPresenterOf(obj.getClass());
 

Specified by:
isPresenterOf in interface Presenter
Parameters:
obj - object type.
Returns:
true if the presenter can handle this type.

isFill

public boolean isFill()
Check if this presenter should always fill the entire area of a cell.

Specified by:
isFill in interface Presenter

setFont

public void setFont(Font font)
Set the font to use for this presenter. A table calls this function before the cell is printed when a presenter is used.

Specified by:
setFont in interface Presenter

getDisplayName

public String getDisplayName()
Get the display name of this presenter.

Specified by:
getDisplayName in interface Presenter
Returns:
a user-friendly name for this presenter.
Since:
5.1

isRawDataRequired

public boolean isRawDataRequired()
Determine if this Presenter requires raw (unformatted) data.

Specified by:
isRawDataRequired in interface Presenter
Returns:
true.

setBackground

public void setBackground(Color bg)
Set the background.

Specified by:
setBackground in interface Presenter

getBackground

public Color getBackground()
Get the background.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.