oracle.dss.gridView.gui
Class UIStyle

java.lang.Object
  |
  +--oracle.dss.gridView.gui.UIStyle

All Implemented Interfaces:

Persistable, StringXMLizable

public class UIStyle

extends java.lang.Object

implements Persistable

A property bag for attributes that describe a Crosstab/Table style. Each style consists of sets of properties associated with row/column headers, data bodies, title, subtitle and footnote.

Field Summary

static java.lang.String

TYPE

Constructor Summary

UIStyle()
Null constructor

UIStyle(java.lang.String name, java.lang.String id, java.lang.String type, boolean isVerticalGridlines, boolean isHorizontalGridlines)
This constructor creates default UI components.

UIStyle(java.lang.String name, java.lang.String id, java.lang.String type, boolean isVerticalGridlines, boolean isHorizontalGridlines, UIComponentStyle rowHeader, UIComponentStyle columnHeader, UIComponentStyle databody, UIComponentStyle title, UIComponentStyle subtitle, UIComponentStyle footnote, UIComponentStyle pageControl)

Method Summary

UIComponentStyle	getColumnHeaderStyle()
UIComponentStyle	getDatabodyStyle()
UIComponentStyle	getFootnoteStyle()
java.lang.String	getID() Returns the ID of the style.
java.lang.String	getName() Returns the display name of the style.
UIComponentStyle	getPageControlStyle()
PersistableAttributes	getPersistableAttributes(PersistableAttributes oldAttrs) Retrieves the attributes of the component, for searching.
UIComponentStyle	getRowHeaderStyle()
UIComponentStyle	getSubtitleStyle()
UIComponentStyle	getTitleStyle()
java.lang.String	getType() Returns the type of the object.
java.lang.String	getXMLAsString() Retrieves the XML representation of the component.
boolean	isHorizontalGridlines() Returns the flag indicating whether horizontal gridlines are present.
boolean	isVerticalGridlines() Returns the flag indicating whether vertical gridlines are present.
void	setColumnHeaderStyle(UIComponentStyle style)
void	setDatabodyStyle(UIComponentStyle style)
void	setFootnoteStyle(UIComponentStyle style)
void	setHorizontalGridlines(boolean isHorizontalGridlines) Sets the flag indicating whether horizontal gridlines are present.
void	setID(java.lang.String id) Sets the ID of the style.
void	setName(java.lang.String name) Sets the display name of the style.
void	setPageControlStyle(UIComponentStyle style)
void	setPersistableAttributes(PersistableAttributes attrs) Specifies attributes that can be used for searching in the BI Beans Catalog.
void	setRowHeaderStyle(UIComponentStyle style)
void	setSubtitleStyle(UIComponentStyle style)
void	setTitleStyle(UIComponentStyle style)
void	setType(java.lang.String type) Sets the type of the object.
void	setVerticalGridlines(boolean isVerticalGridlines) Sets the flag indicating whether vertical gridlines are present.
boolean	setXMLAsString(java.lang.String xml) Specifies the XML representation of the component.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableComponents, initialize, setPersistableComponents

Field Detail

TYPE

public static final java.lang.String TYPE

Constructor Detail

UIStyle

public UIStyle()

Null constructor

UIStyle

public UIStyle(java.lang.String name,
               java.lang.String id,
               java.lang.String type,
               boolean isVerticalGridlines,
               boolean isHorizontalGridlines)

This constructor creates default UI components.

UIStyle

public UIStyle(java.lang.String name,
               java.lang.String id,
               java.lang.String type,
               boolean isVerticalGridlines,
               boolean isHorizontalGridlines,
UIComponentStyle rowHeader,
UIComponentStyle columnHeader,
UIComponentStyle databody,
UIComponentStyle title,
UIComponentStyle subtitle,
UIComponentStyle footnote,
UIComponentStyle pageControl)

Method Detail

setName

public void setName(java.lang.String name)

Sets the display name of the style.

getName

public java.lang.String getName()

Returns the display name of the style.

setID

public void setID(java.lang.String id)

Sets the ID of the style.

getID

public java.lang.String getID()

Returns the ID of the style.

setType

public void setType(java.lang.String type)

Sets the type of the object.

getType

public java.lang.String getType()

Returns the type of the object.

setVerticalGridlines

public void setVerticalGridlines(boolean isVerticalGridlines)

Sets the flag indicating whether vertical gridlines are present.

isVerticalGridlines

public boolean isVerticalGridlines()

Returns the flag indicating whether vertical gridlines are present.

setHorizontalGridlines

public void setHorizontalGridlines(boolean isHorizontalGridlines)

Sets the flag indicating whether horizontal gridlines are present.

isHorizontalGridlines

public boolean isHorizontalGridlines()

Returns the flag indicating whether horizontal gridlines are present.

getPersistableAttributes

public PersistableAttributes getPersistableAttributes(PersistableAttributes oldAttrs)

Description copied from interface: Persistable

Retrieves the attributes of the component, for searching. The attributes are used by the persistence service, when users search the BI Beans Catalog for components that have particular attribute values.

Specified by:

getPersistableAttributes in interface Persistable

Following copied from interface: oracle.dss.util.persistence.Persistable

Parameters:

attrs - The searchable attributes that the application has defined for this component.

Returns:

The full set of attributes for the component.

setPersistableAttributes

public void setPersistableAttributes(PersistableAttributes attrs)

Description copied from interface: Persistable

Specifies attributes that can be used for searching in the BI Beans Catalog.

Specified by:

setPersistableAttributes in interface Persistable

Following copied from interface: oracle.dss.util.persistence.Persistable

Parameters:

attrs - PersistableAttributes that specify search attributes for the component.

setRowHeaderStyle

public void setRowHeaderStyle(UIComponentStyle style)

getRowHeaderStyle

public UIComponentStyle getRowHeaderStyle()

setColumnHeaderStyle

public void setColumnHeaderStyle(UIComponentStyle style)

getColumnHeaderStyle

public UIComponentStyle getColumnHeaderStyle()

setDatabodyStyle

public void setDatabodyStyle(UIComponentStyle style)

getDatabodyStyle

public UIComponentStyle getDatabodyStyle()

setTitleStyle

public void setTitleStyle(UIComponentStyle style)

getTitleStyle

public UIComponentStyle getTitleStyle()

setSubtitleStyle

public void setSubtitleStyle(UIComponentStyle style)

getSubtitleStyle

public UIComponentStyle getSubtitleStyle()

setFootnoteStyle

public void setFootnoteStyle(UIComponentStyle style)

getFootnoteStyle

public UIComponentStyle getFootnoteStyle()

setPageControlStyle

public void setPageControlStyle(UIComponentStyle style)

getPageControlStyle

public UIComponentStyle getPageControlStyle()

getXMLAsString

public java.lang.String getXMLAsString()
                                throws BIPersistenceException

Description copied from interface: StringXMLizable

Retrieves the XML representation of the component. This method is called by the persistence service when the component is saved to the BI Beans Catalog.

Specified by:

getXMLAsString in interface StringXMLizable

Following copied from interface: oracle.dss.util.persistence.StringXMLizable

Returns:

The XML representation of this component.

Throws:

BIPersistenceException - If a problem occurs in getting the XML.

setXMLAsString

public boolean setXMLAsString(java.lang.String xml)
                       throws BIPersistenceException

Description copied from interface: StringXMLizable

Specifies the XML representation of the component. The persistence service calls this method when the component is restored from the BI Beans Catalog.

Specified by:

setXMLAsString in interface StringXMLizable

Following copied from interface: oracle.dss.util.persistence.StringXMLizable

Parameters:

name - The XML representation of the component.

Returns:

true the XML was successfully set, false if not.

Throws:

BIPersistenceException - If a problem occurs in setting the XML.