org.jrabbit.standard.profiler.entities.base
Class BaseProfilerEntity

java.lang.Object
  extended by org.jrabbit.standard.profiler.entities.base.BaseProfilerEntity
All Implemented Interfaces:
Renderable, Referenced, Dimensioned, Visible, ProfilerEntity
Direct Known Subclasses:
FontBasedProfilerEntity, SkinnedProfilerEntity

public abstract class BaseProfilerEntity
extends java.lang.Object
implements ProfilerEntity

A BaseProfilerEntity provides some default functionality that is usable by most ProfilerEntities.

Author:
Chris Molini

Field Summary
protected  float height
          The height of the object.
protected  java.lang.String reference
          The identifier of this object.
protected  boolean visible
          Whether or not the ProfilerEntity is currently visible.
protected  float width
          The width of the object.
 
Constructor Summary
BaseProfilerEntity(java.lang.String reference)
          Creates a BaseProfilerEntity with the supplied identifier.
 
Method Summary
 float height()
          Accesses the dimensions of the ProfilerEntity.
 java.lang.String reference()
          Accesses this ProfilerEntity's reference.
 void setVisible(boolean visible)
          Redefines whether or not the ProfilerEntity is visible.
 boolean visible()
          Learns whether or not the ProfilerEntity is visible.
 float width()
          Accesses the dimensions of the ProfilerEntity.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jrabbit.base.core.types.Renderable
render
 

Field Detail

reference

protected java.lang.String reference
The identifier of this object.


width

protected float width
The width of the object.


height

protected float height
The height of the object.


visible

protected boolean visible
Whether or not the ProfilerEntity is currently visible.

Constructor Detail

BaseProfilerEntity

public BaseProfilerEntity(java.lang.String reference)
Creates a BaseProfilerEntity with the supplied identifier.

Parameters:
reference - The String that will identify this ProfilerEntity.
Method Detail

reference

public java.lang.String reference()
Accesses this ProfilerEntity's reference.

Specified by:
reference in interface Referenced
Returns:
The String that identifies this ProfilerEntity.

width

public float width()
Accesses the dimensions of the ProfilerEntity.

Specified by:
width in interface Dimensioned
Returns:
The width of the ProfilerEntity.

height

public float height()
Accesses the dimensions of the ProfilerEntity.

Specified by:
height in interface Dimensioned
Returns:
The height of the ProfilerEntity.

visible

public boolean visible()
Learns whether or not the ProfilerEntity is visible.

Specified by:
visible in interface Visible
Returns:
True if the ProfilerEntity should be rendered, false if not.

setVisible

public void setVisible(boolean visible)
Redefines whether or not the ProfilerEntity is visible.

Specified by:
setVisible in interface Visible
Parameters:
visible - True if the ProfilerEntity should be rendered, false if not.