Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.dataView.managers
Class ViewStyle

java.lang.Object
  |
  +--oracle.bali.ewt.graphics.Appearance
        |
        +--oracle.dss.dataView.managers.ViewStyle
All Implemented Interfaces:
java.lang.Cloneable, Mergeable, MergeableXML, java.io.Serializable

public class ViewStyle
extends oracle.bali.ewt.graphics.Appearance
implements MergeableXML, java.io.Serializable, java.lang.Cloneable

Contains style properties.

Note: While thin presentation beans use ViewStyle objects to specify styles for components, thin beans use only a subset of the style properties. Descriptions of individual methods describe HTML-client differences.

See Also:
Serialized Form

Field Summary
static int ALL_BORDERS
          All borders of the cell.
static int BORDER_STYLE_DASH
          Border style: dashed line.
static int BORDER_STYLE_DASH_DOT_DOT
          Border style: dash-dot-dot (_.._.._..).
static int BORDER_STYLE_DOT
          Border style: dotted line.
static int BORDER_STYLE_DOT_DASH
          Border style: dot-dash (._._._).
static int BORDER_STYLE_DOUBLE
          Border style: double line.
static int BORDER_STYLE_NO_LINE
          Border style: no border.
static int BORDER_STYLE_NOT_USED
          Border style: no border.
static int BORDER_STYLE_SOLID
          Border style: solid line.
static int BOTTOM_BORDER
          Bottom border of the cell.
static int CELL_EDITABLE
          Cell Edit Style: Databody cell in a thin crosstab or table can be edited.
static int CELL_NOT_EDITABLE
          Cell Edit Style: Databody cell in a thin crosstab or table cannot be edited.
static int LEFT_BORDER
          Left border of the cell.
static int RIGHT_BORDER
          Right border of the cell.
static int TOP_BORDER
          Top border of the cell.

 

Fields inherited from class oracle.bali.ewt.graphics.Appearance
HORIZONTAL_JUSTIFY_CENTER, HORIZONTAL_JUSTIFY_DEFAULT, HORIZONTAL_JUSTIFY_LEFT, HORIZONTAL_JUSTIFY_RIGHT, VERTICAL_JUSTIFY_BOTTOM, VERTICAL_JUSTIFY_MIDDLE, VERTICAL_JUSTIFY_TOP

 

Constructor Summary
ViewStyle()
          Constructor that uses default ViewStyle values.

 

Method Summary
 void clearUsedBits()
          Sets all of the "used" ViewStyle properties to false.
 java.lang.Object clone()
          Clones this ViewStyle object.
 boolean equals(java.lang.Object o)
          Indicates whether the specified object is equivalent to this ViewStyle object.
 java.awt.Color getBackground()
          Retrieves the color for the background.
 java.awt.Color getBorderColor(int side)
          Retrieves the color for the border.
 int getBorderStyle(int side)
          Retrieves the style for the border.
 int getBorderWidth(int side)
          Retrieves the width for the border.
 int getCellEditStyle()
          Retrieves the edit style for a GridView databody cell.
 java.awt.Color getEditBackground()
          Retrieves the background color of editable cells in the databody of a crosstab or table.
 java.awt.Color getEditForeground()
          Retrieves the foreground color for cells that can be edited in the databody of a table or crosstab.
 java.awt.Font getFont()
          Retrieves a Font object for the text.
 java.lang.String getFontName()
          Retrieves the name of the font for the text.
 int getFontSize()
          Retrieves the size of the font for the text.
 int getFontStyle()
          Retrieves the font style for the text, such as bold, italic, or plain.
 java.awt.Color getForeground()
          Retrieves the color for the foreground.
 java.awt.Color getGraphicBarColor()
          Retrieves the color of the graphic bar in the databody cell of a table or crosstab.
 int getGraphicImageIndex()
          Retrieves the index of the graphic image.
 java.lang.String getGraphicImageTooltip()
          Retrieves the text of the tooltip that is displayed when an end user's mouse hovers over the graphic image.
 int getHorizontalAlignment()
          Retrieves the horizontal alignment for the font within its rectangle.
 java.awt.Color getSelectBackground()
          Retrieves the color for the background after it has been selected.
 java.awt.Color getSelectForeground()
          Retrieves the color for the foreground after it has been selected.
 int getVerticalAlignment()
          Retrieves the vertical alignment for the font within its rectangle.
 interface getXML(boolean allProperties, boolean emptyElement)
          Retrieves XML that represents properties and their values in the form of and ObjectNode.
 boolean isAnythingOverridden()
          Indicates whether any of the properties of this ViewSizing has been explicitly set.
 boolean isBackgroundUsed()
          Indicates whether the background property has been explicitly set.
 boolean isBorderColorUsed(int side)
          Indicates whether the BorderColor property has been explicitly set.
 boolean isBorderStyleUsed(int side)
          Indicates whether the BorderStyle property has been explicitly set.
 boolean isBorderWidthUsed(int side)
          Indicates whether the BorderWidth property has been explicitly set.
 boolean isCellEditStyleUsed()
          Indicates whether the CellEditStyle property has been explicitly set.
 boolean isDoubleUnderline()
          Indicates whether the text is underlined with two lines.
 boolean isDoubleUnderlineUsed()
          Indicates whether the DoubleUnderline property has been explicitly set.
 boolean isEditBackgroundUsed()
          Indicates whether the EditBackground property has been explicitly set.
 boolean isEditForegroundUsed()
          Indicates whether the EditForeground property has explicitly been set.
 boolean isFontBold()
          Indicates whether the font style for the text is bold.
 boolean isFontBoldUsed()
          Indicates whether the FontBold property has been explicitly set.
 boolean isFontItalic()
          Indicates whether the font style for the text is italic.
 boolean isFontItalicUsed()
          Indicates whether the FontItalic property has been explicitly set.
 boolean isFontNameUsed()
          Indicates whether the FontName property has been explicitly set.
 boolean isFontSizeUsed()
          Indicates whether the FontSize property has been explicitly set.
 boolean isFontUsed()
          Indicates whether any of certain font properties has been explicitly set.
 boolean isForegroundUsed()
          Indicates whether the Foreground property has been explicitly set.
 boolean isGraphicBarColorUsed()
          Indicates whether the GraphicBarColor property has been explicitly set.
 boolean isGraphicBarVisible()
          Indicates whether a graphic bar appears in the databody cell of a Java-client crosstab or table.
 boolean isGraphicBarVisibleUsed()
          Indicates whether the GraphicBarVisible property has been explicitly set.
 boolean isGraphicImageIndexUsed()
          Indicates whether the GraphicImageIndex property has been explicitly set.
 boolean isGraphicImageTooltipUsed()
          Indicates whether the GraphicImageTooltip property has been explicitly set.
 boolean isHorizontalAlignmentUsed()
          Indicates whether the HorizontalAlignment property has been explicitly set.
 boolean isHPageBreak()
          Indicates whether the horizontal page break line is visible in the databody of a table or crosstab.
 boolean isHPageBreakUsed()
          Indicates whether the HPageBreak property has been explicitly set.
 boolean isSelectBackgroundUsed()
          Indicates whether the SelectBackground property has been explicitly set.
 boolean isSelectForegroundUsed()
          Indicates whether the SelectForeground property has been explicitly set.
 boolean isStrikeThrough()
          Indicates whether the text has a line drawn through it.
 boolean isStrikeThroughUsed()
          Indicates whether the StrikeThrough property has been explicitly set.
 boolean isUnderline()
          Indicates whether the text is underlined with one line.
 boolean isUnderlineUsed()
          Indicates whether the Underline property has been explicitly set.
 boolean isVerticalAlignmentUsed()
          Indicates whether the VerticalAlignment property has been explicitly set.
 boolean isVPageBreak()
          Indicates whether the vertical page break line is visible in the databody of a crosstab or table.
 boolean isVPageBreakUsed()
          Indicates whether the VPageBreak property has been explicitly set.
 boolean isWordWrapEnabled()
          Indicates whether the text is wrapped onto multiple lines.
 boolean isWordWrapEnabledUsed()
          Indicates whether the WordWrapEnabled property has been explicitly set.
 void merge(Mergeable from)
          Merges the specified ViewStyle object with this object.
 void mergeDefaults(ViewStyle from)
          Merges the specified ViewStyle object with this object.
 void setBackground(java.awt.Color background)
          Specifies the color for the background.
 void setBackgroundUsed(boolean used)
          Specifies whether the background property has been explicitly set.
 void setBorderColor(int side, java.awt.Color borderColor)
          Specifies the color for the border.
 void setBorderColorUsed(int side, boolean used)
          Specifies whether the BorderColor property has been explicitly set.
 void setBorderStyle(int side, int borderStyle)
          Specifies the style for the border.
 void setBorderStyleUsed(int side, boolean used)
          Specifies whether the BorderStyle property has been explicitly set.
 void setBorderWidth(int side, int borderWidth)
          Specifies the width for the border.
 void setBorderWidthUsed(int side, boolean used)
          Specifies whether the BorderWidth property has been explicitly set.
 void setCellEditStyle(int style)
          Specifies the edit style for a GridView databody cell.
 void setCellEditStyleUsed(boolean used)
          Specifies whether the CellEditStyle property has been explicitly set.
 void setDoubleUnderline(boolean doubleUnderline)
          Specifies whether the text is underlined with two lines.
 void setDoubleUnderlineUsed(boolean used)
          Specifies whether the DoubleUnderline property has been explicitly set.
 void setEditBackground(java.awt.Color background)
          Specifies the background color for cells that can be edited in the databody of a crosstab or table.
 void setEditBackgroundUsed(boolean used)
          Specifies whether the EditBackground property has been explicitly set.
 void setEditForeground(java.awt.Color foreground)
          Specifies the foreground color for cells that can be edited in the databody of a crosstab or table.
 void setEditForegroundUsed(boolean used)
          Specifies whether the EditForeground property has been explicitly set.
 void setErrorHandler(ErrorHandler eh)
          Specifies the error handler for this ViewStyle.
 void setFont(java.awt.Font font)
          Specifies a Font object for the text.
 void setFontBold(boolean fontBold)
          Specifies whether the font style for the text is bold.
 void setFontBoldUsed(boolean used)
          Specifies whether the FontBold property has been explicitly set.
 void setFontItalic(boolean fontItalic)
          Specifies whether the font style for the text is italic.
 void setFontItalicUsed(boolean used)
          Specifies whether the FontItalic property has been explicitly set.
 void setFontName(java.lang.String fontName)
          Specifies the name of the font for the text.
 void setFontNameUsed(boolean used)
          Specifies whether the FontName property has been explicitly set.
 void setFontSize(int fontSize)
          Specifies the size of the font for the text.
 void setFontSizeUsed(boolean used)
          Specifies whether the FontSize property has been explicitly set.
 void setFontUsed(boolean used)
          Specifies whether the Font property has been explicitly set.
 void setForeground(java.awt.Color foreground)
          Specifies the color for the foreground.
 void setForegroundUsed(boolean used)
          Specifies whether the Foreground property has been explicitly set.
 void setGraphicBarColor(java.awt.Color color)
          Specifies the color of the graphic bar in a databody cell in a table or crosstab.
 void setGraphicBarColorUsed(boolean used)
          Specifies whether the GraphicBarColor property has been explicitly set.
 void setGraphicBarVisible(boolean visible)
          Specifies whether a graphic bar appears in the databody cell of a Java-client crosstab or table.
 void setGraphicBarVisibleUsed(boolean used)
          Specifies whether the GraphicBarVisible property has been explicitly set.
 void setGraphicImageIndex(int index)
          Specifies the index for the image that indicates that a user can drill out from a GridView cell.
 void setGraphicImageIndexUsed(boolean used)
          Specifies whether the GraphicImageIndex property has been explicitly set.
 void setGraphicImageTooltip(java.lang.String tooltip)
          Specifies the text to display in a tooltip when an end user's mouse hovers over the graphic image.
 void setGraphicImageTooltipUsed(boolean used)
          Specifies whether the GraphicImageTooltip property has been explicitly set.
 void setHorizontalAlignment(int horizontalAlignment)
          Specifies the horizontal alignment for the font within its rectangle.
 void setHorizontalAlignmentUsed(boolean used)
          Specifies whether the HorizontalAlignment property has been explicitly set.
 void setHPageBreak(boolean b)
          Specifies whether the horizontal page break line is visible in the databody of a table or crosstab.
 void setHPageBreakUsed(boolean used)
          Specifies whether the HPageBreak property has been explicitly set.
 void setSelectBackground(java.awt.Color selectBackground)
          Specifies the color for the background after it has been selected.
 void setSelectBackgroundUsed(boolean used)
          Specifies whether the SelectBackground property has been explicitly set.
 void setSelectForeground(java.awt.Color selectForeground)
          Specifies the color for the foreground after it has been selected.
 void setSelectForegroundUsed(boolean used)
          Specifies whether the SelectForeground property has been explicitly set.
 void setStrikeThrough(boolean strikeThrough)
          Specifies whether the text has a line drawn through it.
 void setStrikeThroughUsed(boolean used)
          Specifies whether the StrikeThrough property has been explicitly set.
 void setUnderline(boolean underline)
          Specifies whether the text is underlined with one line.
 void setUnderlineUsed(boolean used)
          Specifies whether the Underline property has been explicitly set.
 void setVerticalAlignment(int verticalAlignment)
          Specifies the vertical alignment for the font within its rectangle.
 void setVerticalAlignmentUsed(boolean used)
          Specifies whether the VerticalAlignment property has been explicitly set.
 void setVPageBreak(boolean b)
          Specifies whether the vertical page break line is visible in the databody of a crosstab or table.
 void setVPageBreakUsed(boolean used)
          Specifies whether the VPageBreak property has been explicitly set.
 void setWordWrapEnabled(boolean wordWrap)
          Specifies whether the text is wrapped onto multiple lines.
 void setWordWrapEnabledUsed(boolean used)
          Specifies whether the WordWrapEnabled property has been explicitly set.
 boolean setXML( node, java.lang.String version, int reset)
          Specifies XML that represents properties and values.

 

Methods inherited from class oracle.bali.ewt.graphics.Appearance
copy, getBorderPainter, getHorizontalJustify, getInsets, getReadingDirection, getSelectFont, getVerticalJustify, hashCode, setBorderPainter, setHorizontalJustify, setInsets, setReadingDirection, setSelectFont, setVerticalJustify

 

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

BORDER_STYLE_NOT_USED

public static final int BORDER_STYLE_NOT_USED
Border style: no border.

BORDER_STYLE_SOLID

public static final int BORDER_STYLE_SOLID
Border style: solid line.

BORDER_STYLE_DASH

public static final int BORDER_STYLE_DASH
Border style: dashed line.

BORDER_STYLE_DOT

public static final int BORDER_STYLE_DOT
Border style: dotted line.

BORDER_STYLE_DOT_DASH

public static final int BORDER_STYLE_DOT_DASH
Border style: dot-dash (._._._).

BORDER_STYLE_DASH_DOT_DOT

public static final int BORDER_STYLE_DASH_DOT_DOT
Border style: dash-dot-dot (_.._.._..).

BORDER_STYLE_DOUBLE

public static final int BORDER_STYLE_DOUBLE
Border style: double line.

BORDER_STYLE_NO_LINE

public static final int BORDER_STYLE_NO_LINE
Border style: no border.

TOP_BORDER

public static final int TOP_BORDER
Top border of the cell.

LEFT_BORDER

public static final int LEFT_BORDER
Left border of the cell.

BOTTOM_BORDER

public static final int BOTTOM_BORDER
Bottom border of the cell.

RIGHT_BORDER

public static final int RIGHT_BORDER
Right border of the cell.

ALL_BORDERS

public static final int ALL_BORDERS
All borders of the cell.

CELL_EDITABLE

public static final int CELL_EDITABLE
Cell Edit Style: Databody cell in a thin crosstab or table can be edited.

CELL_NOT_EDITABLE

public static final int CELL_NOT_EDITABLE
Cell Edit Style: Databody cell in a thin crosstab or table cannot be edited.
Constructor Detail

ViewStyle

public ViewStyle()
Constructor that uses default ViewStyle values. At this point, no properties have been explicitly set.
Method Detail

isAnythingOverridden

public boolean isAnythingOverridden()
Indicates whether any of the properties of this ViewSizing has been explicitly set.
Specified by:
isAnythingOverridden in interface Mergeable
Returns:
true if any has been explicitly set, false if the properties have their original values.

clone

public java.lang.Object clone()
Clones this ViewStyle object.
Specified by:
clone in interface Mergeable
Returns:
The clone of this ViewStyle object.

setBackground

public void setBackground(java.awt.Color background)
Specifies the color for the background. This method also sets the BackgroundUsed property to true.
Overrides:
setBackground in class oracle.bali.ewt.graphics.Appearance
Parameters:
background - The color for the background.

getBackground

public java.awt.Color getBackground()
Retrieves the color for the background.
Overrides:
getBackground in class oracle.bali.ewt.graphics.Appearance
Returns:
The color for the background.

isBackgroundUsed

public boolean isBackgroundUsed()
Indicates whether the background property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setBackgroundUsed

public void setBackgroundUsed(boolean used)
Specifies whether the background property has been explicitly set. This method is called by the setBackground method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setForeground

public void setForeground(java.awt.Color foreground)
Specifies the color for the foreground. This method also sets the ForegroundUsed property to true.
Overrides:
setForeground in class oracle.bali.ewt.graphics.Appearance
Parameters:
foreground - The color for the foreground.

getForeground

public java.awt.Color getForeground()
Retrieves the color for the foreground.
Overrides:
getForeground in class oracle.bali.ewt.graphics.Appearance
Returns:
The color for the foreground.

isForegroundUsed

public boolean isForegroundUsed()
Indicates whether the Foreground property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, if the property has not been explicitly set.

setForegroundUsed

public void setForegroundUsed(boolean used)
Specifies whether the Foreground property has been explicitly set. This method is called by the setForeground method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, if the property has not been explicitly set.

setSelectBackground

public void setSelectBackground(java.awt.Color selectBackground)
Specifies the color for the background after it has been selected. This method also sets the SelectBackgroundUsed property to true.
Overrides:
setSelectBackground in class oracle.bali.ewt.graphics.Appearance
Parameters:
background - The color for the background after it has been selected.

getSelectBackground

public java.awt.Color getSelectBackground()
Retrieves the color for the background after it has been selected.
Overrides:
getSelectBackground in class oracle.bali.ewt.graphics.Appearance
Returns:
The color for the background after it has been selected.

isSelectBackgroundUsed

public boolean isSelectBackgroundUsed()
Indicates whether the SelectBackground property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setSelectBackgroundUsed

public void setSelectBackgroundUsed(boolean used)
Specifies whether the SelectBackground property has been explicitly set. This method is called by the setSelectBackground method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setSelectForeground

public void setSelectForeground(java.awt.Color selectForeground)
Specifies the color for the foreground after it has been selected. This method also sets the SelectForegroundUsed property to true.
Overrides:
setSelectForeground in class oracle.bali.ewt.graphics.Appearance
Parameters:
foreground - The color for the foreground after it has been selected.

getSelectForeground

public java.awt.Color getSelectForeground()
Retrieves the color for the foreground after it has been selected.
Overrides:
getSelectForeground in class oracle.bali.ewt.graphics.Appearance
Returns:
The color for the foreground after it has been selected.

isSelectForegroundUsed

public boolean isSelectForegroundUsed()
Indicates whether the SelectForeground property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setSelectForegroundUsed

public void setSelectForegroundUsed(boolean used)
Specifies whether the SelectForeground property has been explicitly set. This method is called by the setSelectForeground method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setHorizontalAlignment

public void setHorizontalAlignment(int horizontalAlignment)
Specifies the horizontal alignment for the font within its rectangle. The swing constants for horizontal alignment are LEFT, CENTER, RIGHT and LEADING. This method also sets the HorizontalAlignmentUsed property to true.
Parameters:
horizontalAlignment - A swing constant that represents the horizontal alignment of the font within its rectangle.

getHorizontalAlignment

public int getHorizontalAlignment()
Retrieves the horizontal alignment for the font within its rectangle. The swing constants for horizontal alignment are LEFT, CENTER, RIGHT AND LEADING.
Returns:
A swing constant that represents the horizontal alignment of the font within its rectangle.

isHorizontalAlignmentUsed

public boolean isHorizontalAlignmentUsed()
Indicates whether the HorizontalAlignment property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has been explicitly set.

setHorizontalAlignmentUsed

public void setHorizontalAlignmentUsed(boolean used)
Specifies whether the HorizontalAlignment property has been explicitly set. This method is called by the setHorizontalAlignment method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setVerticalAlignment

public void setVerticalAlignment(int verticalAlignment)
Specifies the vertical alignment for the font within its rectangle. The swing constants for vertical alignment are TOP, CENTER, and BOTTOM. This method also sets the VerticalAlignmentUsed property to true.

Note: In Netscape 4.x, VerticalAlignment is not supported in cells that have images, either drill images or graphic images.

Parameters:
verticalAlignment - A swing constant that represents the vertical alignment of the font within its rectangle.

getVerticalAlignment

public int getVerticalAlignment()
Retrieves the vertical alignment for the font within its rectangle. The swing constants for vertical alignment are TOP, CENTER, and BOTTOM.

Note: In Netscape 4.x, VerticalAlignment is not supported in cells that have images, either drill images or graphic images.

Returns:
A swing constant that represents the vertical alignment of the font within its rectangle.

isVerticalAlignmentUsed

public boolean isVerticalAlignmentUsed()
Indicates whether the VerticalAlignment property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setVerticalAlignmentUsed

public void setVerticalAlignmentUsed(boolean used)
Specifies whether the VerticalAlignment property has been explicitly set. This method is called by the setVerticalAlignment method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setUnderline

public void setUnderline(boolean underline)
Specifies whether the text is underlined with one line. This method also sets the UnderlineUsed property to true.
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.
Returns:
true if the text is underlined with one line, false if the text is not underlined with one line.

isUnderlineUsed

public boolean isUnderlineUsed()
Indicates whether the Underline property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setUnderlineUsed

public void setUnderlineUsed(boolean used)
Specifies whether the Underline property has been explicitly set. This method is called by the setUnderline method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setDoubleUnderline

public void setDoubleUnderline(boolean doubleUnderline)
Specifies whether the text is underlined with two lines. To double underline text, set the setUnderline method to false. This method also sets the DoubleUnderline property to true.

Note: This property is ignored by thin presentation beans.

Parameters:
doubleUnderline - true to underline the text with two lines, false to prevent the text from being underlined with two lines.

isDoubleUnderline

public boolean isDoubleUnderline()
Indicates whether the text is underlined with two lines. To double underline text, set the setUnderline method to false. This method also sets the setDoubleUnderline method to true.

Note: This property is ignored by thin presentation beans.

Returns:
true if the text is underlined with two lines, false if the text is not underlined with two lines.

isDoubleUnderlineUsed

public boolean isDoubleUnderlineUsed()
Indicates whether the DoubleUnderline property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setDoubleUnderlineUsed

public void setDoubleUnderlineUsed(boolean used)
Specifies whether the DoubleUnderline property has been explicitly set. This method is called by the setDoubleUnderlie method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setStrikeThrough

public void setStrikeThrough(boolean strikeThrough)
Specifies whether the text has a line drawn through it. This method also sets the StrikeThroughUsed property to true.
Parameters:
strikeThrough - true to draw a line through the text, false to display the text without a line through it.

isStrikeThrough

public boolean isStrikeThrough()
Indicates whether the text has a line drawn through it.
Returns:
true if the text has a line drawn through it, false if the text is displayed without a line drawn through it.

isStrikeThroughUsed

public boolean isStrikeThroughUsed()
Indicates whether the StrikeThrough property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setStrikeThroughUsed

public void setStrikeThroughUsed(boolean used)
Specifies whether the StrikeThrough property has been explicitly set. This method is called by the setStrikeThrough method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setWordWrapEnabled

public void setWordWrapEnabled(boolean wordWrap)
Specifies whether the text is wrapped onto multiple lines. This method also sets the WordWrapEnabledUsed property to true.
Parameters:
wordWrapEnabled - true to wrap the text onto multiple lines, false to prevent the text from being wrapped onto multiple lines.

isWordWrapEnabled

public boolean isWordWrapEnabled()
Indicates whether the text is wrapped onto multiple lines.
Returns:
true if the text is wrapped onto multiple lines, false if the text is not wrapped onto multiple lines.

isWordWrapEnabledUsed

public boolean isWordWrapEnabledUsed()
Indicates whether the WordWrapEnabled property has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setWordWrapEnabledUsed

public void setWordWrapEnabledUsed(boolean used)
Specifies whether the WordWrapEnabled property has been explicitly set. This method is called by the setWordWrapEnabled method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
used - true if the property has been explicitly set, false if the property has not been explicitly set.

setBorderColor

public void setBorderColor(int side,
                           java.awt.Color borderColor)
Specifies the color for the border. This method also sets the BorderColorUsed property to true.

In order to see the border color, the BorderStyle and BorderWidth properties must be set so that the border can be perceived.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - A constant that indicates which border whose color you want to set. Valid constants are listed in the See Also section.
borderColor - The color for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

getBorderColor

public java.awt.Color getBorderColor(int side)
Retrieves the color for the border.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - The side of the cell border whose color you want. Valid constants are listed in the See Also section.
Returns:
The color for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

isBorderColorUsed

public boolean isBorderColorUsed(int side)
Indicates whether the BorderColor property has been explicitly set. When the return value of this method is true, then the property's value will be used in the merging process.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.

setBorderColorUsed

public void setBorderColorUsed(int side,
                               boolean used)
Specifies whether the BorderColor property has been explicitly set. This method is called by the setBorderColor method. When the parameter value of this method is true, the property's value will be used in the merging process.
Parameters:
side - The side whose border color has been set. Valid constants are listed in the See Also section.
used - true if the property has been explicitly set, false if the property has not been explicitly set.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

setBorderWidth

public void setBorderWidth(int side,
                           int borderWidth)
Specifies the width for the border. This method also sets the BorderWidthUsed property to true.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - A constant that indicates which border whose width you want to set. Valid constants are listed in the See Also section.
borderWidth - The width for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

getBorderWidth

public int getBorderWidth(int side)
Retrieves the width for the border.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - The side whose border width you want.
Returns:
The width for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

isBorderWidthUsed

public boolean isBorderWidthUsed(int side)
Indicates whether the BorderWidth property has been explicitly set. When the return value of this method is true, then the property's value will be used in the merging process.
Parameters:
side - The side whose border width property might be set.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

setBorderWidthUsed

public void setBorderWidthUsed(int side,
                               boolean used)
Specifies whether the BorderWidth property has been explicitly set. This method is called by the setBorderWidth method. When the parameter value of this method is true, then the property's value will be used in the merging process.
Parameters:
side - The side whose border width has been set. Valid constants are listed in the See Also section.
used - true if the property has been explicitly set, false if the property has not been explicitly set.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

setBorderStyle

public void setBorderStyle(int side,
                           int borderStyle)
Specifies the style for the border. This method also sets the BorderStyleUsed property to true.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - A constant that indicates which border whose style you want to set. Valid constants are listed in the See Also section.
borderStyle - The style for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

getBorderStyle

public int getBorderStyle(int side)
Retrieves the style for the border.

Note: Thin presentation beans do not support this property in Netscape 4.x.

Parameters:
side - The side whose border style you want. Valid constants are listed in the See Also section.
Returns:
The style for the border.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

isBorderStyleUsed

public boolean isBorderStyleUsed(int side)
Indicates whether the BorderStyle property has been explicitly set. When the return value of this method is true, then the property's value will be used in the merging process.
Parameters:
side - The side whose border style might be set. Valid constants are listed in the See Also section.
Returns:
true if the property has been explicitly set, false if the property has not been explicitly set.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

setBorderStyleUsed

public void setBorderStyleUsed(int side,
                               boolean used)
Specifies whether the BorderStyle property has been explicitly set. This method is called by the setBorderStyle method. When the parameter value of this method is true, then the property's value will be used in the merging process.
Parameters:
side - The side whose border style has been set. Valid constants are listed in the See Also section.
used - true if the property has been explicitly set, false if the property has not been explicitly set.
See Also:
TOP_BORDER, BOTTOM_BORDER, LEFT_BORDER, RIGHT_BORDER, ALL_BORDERS

setFont

public void setFont(java.awt.Font font)
Specifies a Font object for the text. This method also sets the FontUsed property to true.
Overrides:
setFont in class oracle.bali.ewt.graphics.Appearance
Parameters:
font - A Font object for the text. If the font size that font specifies is not a positive number, then this method logs an error with the error handler and does not change the font size. In this case, the font name, bold, and italic properties are set, even though the size is not.

getFont

public java.awt.Font getFont()
Retrieves a Font object for the text.
Overrides:
getFont in class oracle.bali.ewt.graphics.Appearance
Returns:
A Font object for the text.

isFontUsed

public boolean isFontUsed()
Indicates whether any of certain font properties has been explicitly set. When the return value of this method is true, the property's value will be used in the merging process.

This method returns true if any of the following methods returns true:

Returns:
true if a font property has been explicitly set, false if none of them have been explicitly set.

setFontUsed

public void setFontUsed(boolean used)
Specifies whether the Font property has been explicitly set. This method is called by the setFont method. When the parameter value of this method is true, the property's value will be used in the merging process.

This method calls the following methods, passing the used value that is passed to this method: