Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1)

E12063-04

oracle.dss.gauge
Class BaseFrame

java.lang.Object
  extended by oracle.dss.gauge.BaseGaugeComponent
      extended by oracle.dss.gauge.BaseFrame
Direct Known Subclasses:
GaugeBackground, GaugeFrame, GaugeSetBackground, LegendArea, LowerLabelFrame, PlotArea, UpperLabelFrame

public abstract class BaseFrame
extends BaseGaugeComponent

Represents the base support for frame-like Gauge components.

Since:
11.0

Field Summary
protected  java.lang.String m_borderColorKey
           
protected  java.awt.Color m_defaultBorderColor
           
protected  java.awt.Color m_defaultFillColor
           
protected  boolean m_defaultVisible
           
protected  java.lang.String m_fillColorKey
           
protected  boolean m_isGaugeSetComponent
           
protected  SFX m_sfx
           
protected  int m_sfxID
           
protected  java.lang.String m_visibleKey
           
 
Fields inherited from class oracle.dss.gauge.BaseGaugeComponent
m_commonGauge, m_compType
 
Constructor Summary
BaseFrame(CommonGauge gauge, int compID)
           
 
Method Summary
 java.awt.Color getBorderColor()
          Retrieves the fill color for this frame.
 java.awt.Color getFillColor()
          Retrieves the fill color for this frame.
 SFX getSFX()
          Retrieves the SFX object for this frame.
 boolean isVisible()
          Retrieves whether or not the frame should be visible.
 void setBorderColor(java.awt.Color borderColor)
          Specifies the border color for this frame.
 void setFillColor(java.awt.Color fillColor)
          Specifies the fill color for the background of this frame.
 void setVisible(boolean visible)
          Specifies whether or not this frame should be visible.
 
Methods inherited from class oracle.dss.gauge.BaseGaugeComponent
getComponentName, getComponentType, selectObject
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_visibleKey

protected java.lang.String m_visibleKey

m_fillColorKey

protected java.lang.String m_fillColorKey

m_borderColorKey

protected java.lang.String m_borderColorKey

m_sfxID

protected int m_sfxID

m_defaultVisible

protected boolean m_defaultVisible

m_defaultFillColor

protected java.awt.Color m_defaultFillColor

m_defaultBorderColor

protected java.awt.Color m_defaultBorderColor

m_isGaugeSetComponent

protected boolean m_isGaugeSetComponent

m_sfx

protected SFX m_sfx
For internal use only. Application developers should not use this
Constructor Detail

BaseFrame

public BaseFrame(CommonGauge gauge,
                 int compID)
Parameters:
gauge - The gauge that this object belongs to.
For internal use only. Application developers should not use this
Constructor. Application developers should not have to construct this object, because the gauge does it automatically.
Method Detail

isVisible

public boolean isVisible()
Retrieves whether or not the frame should be visible.

Returns:
TRUE if the frame should be visible, FALSE otherwise.

setVisible

public void setVisible(boolean visible)
Specifies whether or not this frame should be visible.

Parameters:
visible - TRUE if the frame should be visible, FALSE otherwise.

getFillColor

public java.awt.Color getFillColor()
Retrieves the fill color for this frame.

Returns:
The fill color.

setFillColor

public void setFillColor(java.awt.Color fillColor)
Specifies the fill color for the background of this frame.

Parameters:
fillColor - The fill color for this frame.

getBorderColor

public java.awt.Color getBorderColor()
Retrieves the fill color for this frame.

Returns:
The fill color.

setBorderColor

public void setBorderColor(java.awt.Color borderColor)
Specifies the border color for this frame.

Parameters:
borderColor - The border color.

getSFX

public SFX getSFX()
Retrieves the SFX object for this frame. The SFX object specifies attributes for special effects.

Returns:
The SFX object.

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1)

E12063-04

Copyright © 1997, 2010, Oracle. All rights reserved.