oracle.dss.dataView

Class CommonBaseTitle

java.lang.Object

oracle.dss.dataView.CommonBaseTitle

All Implemented Interfaces:

BaseTitleAttributes, DataviewTitles, FontAttribute, HorizontalAlignment, Titles, ViewComponent

@Concealed
public class CommonBaseTitle
extends java.lang.Object
implements ViewComponent, BaseTitleAttributes

For internal use only. Application developers should not use this

CommonBaseTitle used by thin DataviewTitles

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseTitleXML	_baseTitleXML
protected java.util.BitSet	_styleOverrideFlags
protected java.util.BitSet	_userOverrideFlags
protected CommonDataview	dataView
protected java.awt.Color	m_background
protected oracle.dss.dataView.CommonBaseTitle.TitleState	m_baseState
protected oracle.dss.dataView.CommonBaseTitle.TitleState	m_checkpointState
protected static java.lang.String	m_errorMsg
protected static java.lang.String	m_errorSetFont
protected java.awt.Font	m_font
protected java.awt.Color	m_foreground
protected int	m_hAlign
protected static java.lang.String	m_method_setFont
protected static java.lang.String	m_method_setText
protected java.lang.String	m_text
protected boolean	m_underline
protected boolean	m_visible

Fields inherited from interface oracle.dss.dataView.BaseTitleAttributes

ATTR_BACKGROUND, ATTR_FONTBOLD, ATTR_FONTITALIC, ATTR_FONTNAME, ATTR_FONTSIZE, ATTR_FOREGROUND, ATTR_HORIZONTALALIGNMENT, ATTR_STYLE_MAXID, ATTR_UNDERLINE

Constructor Summary

Constructors

Constructor and Description
CommonBaseTitle(java.lang.String t, CommonDataview v, int id)

Method Summary

Modifier and Type	Method and Description
void	createPropertyOverrideFlags()
void	establishBaseState()
void	establishCheckpointState()
java.awt.Color	getBackground() Retrieves the background color for the title.
java.beans.BeanInfo	getBeanInfo() Return a BeanInfo structure representing public properties this component wants to expose in an IDE.
java.lang.String	getComponentName() Retrieves the name of the title.
java.awt.Font	getFont() Retrieves the font for the text.
java.lang.String	getFontName() get font name
int	getFontSize() get font size
java.awt.Color	getForeground() Retrieves the text color for the title.
int	getHorizontalAlignment() Retrieves a horizontal alignment attribute.
int	getID() Retrieves the ID for the title component.
oracle.dss.util.xml.ObjectNode	getStateAsObjectNode(java.lang.String nodeName, boolean isCheckpoint)
oracle.dss.util.xml.ObjectNode	getStyleXML(boolean allProperties)
java.lang.String	getText() Returns the parsed text for a string that includes variables.
java.lang.String	getUnParseText() Retrieves the unparsed text for the title.
oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties)
protected void	init() ThinBean State Management Support
protected void	initState()
boolean	isBackgroundUsed()
boolean	isFontBold() is font bold?
boolean	isFontItalic() is font italic?
boolean	isForegroundUsed()
boolean	isStyleOverrideFlag(int attrID)
boolean	isUnderline() Indicates whether the text is underlined with one line.
boolean	isUserOverrideFlag(int attrID)
boolean	isVisible() Indicates whether the title is visible.
void	resetStyle()
void	resetToDefault(int reset)
void	setBackground(java.awt.Color bg) Specifies the background color for the title.
void	setFont(java.awt.Font f) Specifies font for the text.
void	setFontBold(boolean bold) specifies wheather the font is bold.
void	setFontItalic(boolean italic) specifies wheather the font is italic.
void	setFontName(java.lang.String name) specifies the font name.
void	setFontSize(int size) specifies the font size.
void	setForeground(java.awt.Color fg) Specifies the text color for the title.
void	setHorizontalAlignment(int horizontalAlignment) Specifies a horizontal alignment attribute.
void	setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node, boolean isCheckpoint)
void	setStyleProperty(int attrID, java.lang.String value)
void	setStyleXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset)
void	setText(java.lang.String t) Specifies the parsed text for a string that includes variables.
void	setUnderline(boolean underline) Specifies whether the text is underlined with one line.
void	setVisible(boolean b) Specifies whether the title is visible.
void	setXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset)
void	setXML(oracle.dss.util.xml.ObjectNode node, java.lang.String version, int reset, java.util.HashMap map)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_baseState

@Concealed
protected oracle.dss.dataView.CommonBaseTitle.TitleState m_baseState

For internal use only. Application developers should not use this

m_checkpointState

@Concealed
protected oracle.dss.dataView.CommonBaseTitle.TitleState m_checkpointState

For internal use only. Application developers should not use this

_userOverrideFlags

@Concealed
protected java.util.BitSet _userOverrideFlags

For internal use only. Application developers should not use this

_styleOverrideFlags

@Concealed
protected java.util.BitSet _styleOverrideFlags

For internal use only. Application developers should not use this

dataView

@Concealed
protected CommonDataview dataView

For internal use only. Application developers should not use this

m_text

@Concealed
protected java.lang.String m_text

For internal use only. Application developers should not use this

m_visible

@Concealed
protected boolean m_visible

For internal use only. Application developers should not use this

m_font

@Concealed
protected java.awt.Font m_font

For internal use only. Application developers should not use this

m_underline

@Concealed
protected boolean m_underline

For internal use only. Application developers should not use this

m_hAlign

@Concealed
protected int m_hAlign

For internal use only. Application developers should not use this

m_background

@Concealed
protected java.awt.Color m_background

For internal use only. Application developers should not use this

m_foreground

@Concealed
protected java.awt.Color m_foreground

For internal use only. Application developers should not use this

m_errorSetFont

@Concealed
protected static final java.lang.String m_errorSetFont

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_setText

@Concealed
protected static final java.lang.String m_method_setText

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_method_setFont

@Concealed
protected static final java.lang.String m_method_setFont

See Also:

Constant Field Values

For internal use only. Application developers should not use this

m_errorMsg

@Concealed
protected static final java.lang.String m_errorMsg

See Also:

Constant Field Values

For internal use only. Application developers should not use this

_baseTitleXML

protected BaseTitleXML _baseTitleXML

Constructor Detail

CommonBaseTitle

@Concealed
public CommonBaseTitle(java.lang.String t,
                                  CommonDataview v,
                                  int id)

Parameters:

t - The text for the title.

v - The data view that the title belongs to.

For internal use only. Application developers should not use this

Constructor.

Method Detail

setVisible

public void setVisible(boolean b)

Specifies whether the title is visible.

Specified by:

setVisible in interface Titles

Parameters:

b - true to make the title visible, false to make the title invisible.

getID

public int getID()

Retrieves the ID for the title component.

Specified by:

getID in interface ViewComponent

Returns:

The ID for the title component.

getComponentName

public java.lang.String getComponentName()

Retrieves the name of the title.

Specified by:

getComponentName in interface BaseTitleAttributes

Specified by:

getComponentName in interface ViewComponent

Returns:

The name of the title.

isVisible

public boolean isVisible()

Indicates whether the title is visible.

Specified by:

isVisible in interface Titles

Returns:

true if it is visible, false if it is invisible.

setText

public void setText(java.lang.String t)

Specifies the parsed text for a string that includes variables.

Specified by:

setText in interface Titles

Parameters:

t - The parsed text for a string that includes variables.

getText

public java.lang.String getText()

Returns the parsed text for a string that includes variables.

Specified by:

getText in interface Titles

Returns:

The parsed text for a string that includes variables.

getUnParseText

public java.lang.String getUnParseText()

Retrieves the unparsed text for the title. Unparsed text is text with variable names instead of variable definitions.

Specified by:

getUnParseText in interface Titles

Returns:

The unparsed text for the title.

See Also:

TokenSubstitution

setFont

public void setFont(java.awt.Font f)

Specifies font for the text.

Specified by:

setFont in interface FontAttribute

Parameters:

font - The font for the text.

getFont

public java.awt.Font getFont()

Retrieves the font for the text.

Specified by:

getFont in interface FontAttribute

Returns:

The font for the text.

getFontSize

public int getFontSize()

get font size

setFontSize

public void setFontSize(int size)

specifies the font size.

Parameters:

size - of the font

getFontName

public java.lang.String getFontName()

get font name

setFontName

public void setFontName(java.lang.String name)

specifies the font name.

Parameters:

name - of the font

isFontBold

public boolean isFontBold()

is font bold?

setFontBold

public void setFontBold(boolean bold)

specifies wheather the font is bold.

Parameters:

bold - true to set the font to bold false to prevent the font to be bold.

isFontItalic

public boolean isFontItalic()

is font italic?

setFontItalic

public void setFontItalic(boolean italic)

specifies wheather the font is italic.

Parameters:

italic - true to set the font to italic false to prevent the font to be italic.

setStyleProperty

@Concealed
public void setStyleProperty(int attrID,
                                        java.lang.String value)

Specified by:

setStyleProperty in interface BaseTitleAttributes

For internal use only. Application developers should not use this

set a font attributes to a specified value

setUnderline

public void setUnderline(boolean underline)

Specifies whether the text is underlined with one line.

Specified by:

setUnderline in interface DataviewTitles

Parameters:

underline - true to underline the text with one line, false to prevent the text from being underlined with one line.

isUnderline

public boolean isUnderline()

Indicates whether the text is underlined with one line.

Specified by:

isUnderline in interface DataviewTitles

Returns:

true if the text is underlined with one line, false if the text is not underlined with one line.

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)

Specifies a horizontal alignment attribute.

Specified by:

setHorizontalAlignment in interface HorizontalAlignment

Parameters:

horizontalAlignment - A constant that represents a horizontal alignment attribute. Valid constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves a horizontal alignment attribute.

Specified by:

getHorizontalAlignment in interface HorizontalAlignment

Returns:

A constant that represents a horizontal alignment attribute. Valid constants are SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT

getBackground

public java.awt.Color getBackground()

Retrieves the background color for the title.

Specified by:

getBackground in interface DataviewTitles

Returns:

The background color for the title.

setBackground

public void setBackground(java.awt.Color bg)

Specifies the background color for the title.

Specified by:

setBackground in interface DataviewTitles

Parameters:

bg - The background color for the title.

getForeground

public java.awt.Color getForeground()

Retrieves the text color for the title.

Specified by:

getForeground in interface DataviewTitles

Returns:

The text color for the title.

setForeground

public void setForeground(java.awt.Color fg)

Specifies the text color for the title.

Specified by:

setForeground in interface DataviewTitles

Parameters:

fg - The text color for the title.

getBeanInfo

@Concealed
public java.beans.BeanInfo getBeanInfo()

Description copied from interface: ViewComponent

Return a BeanInfo structure representing public properties this component wants to expose in an IDE.

Specified by:

getBeanInfo in interface ViewComponent

Returns:

array of BeanInfo structures if there are any, null if there are none.

For internal use only. Application developers should not use this

Retrieves the BeanInfo structures that represent the properties for this title component that you want to expose in an IDE.

toString

@Concealed
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

The name of the class that you are debugging.

For internal use only. Application developers should not use this

Prevents a stack overflow when you are debugging.

setXML

@Concealed
public void setXML(oracle.dss.util.xml.ObjectNode node,
                              java.lang.String version,
                              int reset)

Specified by:

setXML in interface BaseTitleAttributes

For internal use only. Application developers should not use this

Sets XML on this component

setXML

@Concealed
public void setXML(oracle.dss.util.xml.ObjectNode node,
                              java.lang.String version,
                              int reset,
                              java.util.HashMap map)

Specified by:

setXML in interface BaseTitleAttributes

For internal use only. Application developers should not use this

Sets XML on this component

getXML

@Concealed
public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties)

Specified by:

getXML in interface BaseTitleAttributes

For internal use only. Application developers should not use this

Retrieves XML from this component

resetToDefault

@Concealed
public void resetToDefault(int reset)

For internal use only. Application developers should not use this

resets to default values

isForegroundUsed

@Concealed
public boolean isForegroundUsed()

Specified by:

isForegroundUsed in interface BaseTitleAttributes

For internal use only. Application developers should not use this

isBackgroundUsed

@Concealed
public boolean isBackgroundUsed()

Specified by:

isBackgroundUsed in interface BaseTitleAttributes

For internal use only. Application developers should not use this

setStyleXML

@Concealed
public void setStyleXML(oracle.dss.util.xml.ObjectNode node,
                                   java.lang.String version,
                                   int reset)

Specified by:

setStyleXML in interface BaseTitleAttributes

For internal use only. Application developers should not use this

Sets Style XML on this component

getStyleXML

@Concealed
public oracle.dss.util.xml.ObjectNode getStyleXML(boolean allProperties)

Specified by:

getStyleXML in interface BaseTitleAttributes

For internal use only. Application developers should not use this

Retrieves Style XML from this component

createPropertyOverrideFlags

@Concealed
public void createPropertyOverrideFlags()

For internal use only. Application developers should not use this

Create both styleOverride and userOverride flags

isUserOverrideFlag

@Concealed
public boolean isUserOverrideFlag(int attrID)

Specified by:

isUserOverrideFlag in interface BaseTitleAttributes

For internal use only. Application developers should not use this

check to see if a property is overridden by user?

isStyleOverrideFlag

@Concealed
public boolean isStyleOverrideFlag(int attrID)

Specified by:

isStyleOverrideFlag in interface BaseTitleAttributes

For internal use only. Application developers should not use this

check to see if a property is overridden by style?

resetStyle

@Concealed
public void resetStyle()

For internal use only. Application developers should not use this

reset style properties

init

protected void init()

ThinBean State Management Support

initState

protected void initState()

establishBaseState

public void establishBaseState()

establishCheckpointState

public void establishCheckpointState()

setStateAsObjectNode

public void setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node,
                                 boolean isCheckpoint)

getStateAsObjectNode

public oracle.dss.util.xml.ObjectNode getStateAsObjectNode(java.lang.String nodeName,
                                                           boolean isCheckpoint)