Style Intelligence v12.0

inetsoft.report.painter
Class RulerPresenter

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

public class RulerPresenter
extends Object
implements Presenter

This presenter draws a ruler (coordinate axis). A value can be plotted on the ruler. Or a rule can be drawn by itself.

See Also:
Serialized Form

Constructor Summary
RulerPresenter()
           
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 Color getBackground()
          Get the background.
 String getDisplayName()
          Get the display name of this presenter.
 NumberFormat getFormat()
          Get the format used to convert number to label.
 double getIncrement()
          Get the increment value.
 double getMaximum()
          Get the maximum value.
 NumberFormat getMaximumFormat()
          Get the format for the maximum label.
 double getMinimum()
          Get the minimum value.
 NumberFormat getMinimumFormat()
          Get the format for the minimum label.
 double getMinorIncrement()
          Get the minor increment value.
 Dimension getPreferredSize(Object v)
          Calculate the preferred size of the object representation.
 int hashCode()
          Get the presenter's hash code.
 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 g0, Object v, int x, int y, int w, int h)
          Paint an object at the specified location.
 void setBackground(Color bg)
          Set the background.
 boolean setFill(boolean fill)
          Set the property to fill the entire area of the cell.
 void setFont(Font font)
          Set the font to use for this presenter.
 void setFormat(NumberFormat format)
          Set the format used to convert number to label.
 void setIncrement(double increment)
          Set the increment value.
 void setMaximum(double max)
          Set the maximum value.
 void setMaximumFormat(NumberFormat format)
          Set the format for the maximum label.
 void setMinimum(double min)
          Set the minimum value.
 void setMinimumFormat(NumberFormat format)
          Set the format for the minimum label.
 void setMinorIncrement(double increment)
          Set the minor increment value.
 void setPreferredSize(Dimension psize)
          Change the preferred size of the presenter.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RulerPresenter

public RulerPresenter()
Method Detail

getMaximum

public double getMaximum()
Get the maximum value.


setMaximum

public void setMaximum(double max)
Set the maximum value.


getMinimum

public double getMinimum()
Get the minimum value.


setMinimum

public void setMinimum(double min)
Set the minimum value.


getIncrement

public double getIncrement()
Get the increment value.


setIncrement

public void setIncrement(double increment)
Set the increment value.


getMinorIncrement

public double getMinorIncrement()
Get the minor increment value.


setMinorIncrement

public void setMinorIncrement(double increment)
Set the minor increment value.


getFormat

public NumberFormat getFormat()
Get the format used to convert number to label.


setFormat

public void setFormat(NumberFormat format)
Set the format used to convert number to label.


getMinimumFormat

public NumberFormat getMinimumFormat()
Get the format for the minimum label. Use the regular format if not set.


setMinimumFormat

public void setMinimumFormat(NumberFormat format)
Set the format for the minimum label. Use the regular format if not set.


getMaximumFormat

public NumberFormat getMaximumFormat()
Get the format for the maximum label. Use the regular format if not set.


setMaximumFormat

public void setMaximumFormat(NumberFormat format)
Set the format for the maximum label. Use the regular format if not set.


paint

public void paint(Graphics g0,
                  Object v,
                  int x,
                  int y,
                  int w,
                  int h)
Paint an object at the specified location.

Specified by:
paint in interface Presenter
Parameters:
g0 - 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.

setPreferredSize

public void setPreferredSize(Dimension psize)
Change the preferred size of the presenter.


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

setFill

public boolean setFill(boolean fill)
Set the property to fill the entire area of the cell.

Parameters:
fill - true to fill the cell area.

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

equals

public boolean equals(Object obj)
Check if equals another object.

Overrides:
equals in class Object
Parameters:
obj - the specified object
Returns:
true if equals, false otherwise

hashCode

public int hashCode()
Get the presenter's hash code.

Overrides:
hashCode in class Object
Returns:
hash code

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.