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


oracle.dss.gridView.gui
Class StylePanel

oracle.dss.gridView.gui.StylePanel
All Implemented Interfaces:
java.awt.event.ActionListener, javax.swing.event.ChangeListener, java.util.EventListener, HelpContext, java.awt.event.ItemListener, javax.swing.event.ListSelectionListener, java.beans.PropertyChangeListener

public class StylePanel
implements java.awt.event.ItemListener, java.beans.PropertyChangeListener, javax.swing.event.ChangeListener, java.awt.event.ActionListener, HelpContext, javax.swing.event.ListSelectionListener

Defines the gridView Style panel. End-users use the gridView Style panel to set options of table or crosstab

This class fires propertyChange events for every property that is exposed in this panel.

See Also:
Serialized Form

Constructor Summary
StylePanel(UIGridView gridView)
          Constructor.

 

Method Summary
 void addStyleToList(UIStyle style)
          Add new style to Style List
 boolean apply()
          Applies to the gridView the changes that have been made to this panel.
 void cleanUp()
          Clean up the inner classes and components
 java.lang.String getApplicationName()
          Retrieves the name of the application that uses this panel.
 CustomObjectManager getCustomObjectManager()
          Retrives persistance object manager for StylePanel
 ErrorHandler getErrorHandler()
          Retrieves the error handler that this Style uses.
 FormatsPanel getFormatsPanel()
          Retrive FormatsPanel working with current StylePanel
 UIGridView getGridView()
          Retrive the gridView whose properties this panel sets.
 java.lang.String getHelpContextID()
          Retrieves the Help context ID for this panel.
 java.awt.Dimension getMinimumSize()
          Retrieves the minimum size of the Plot Area panel.
 OptionsPanel getOptionsPanel()
          Retrive OptionsPanel working with current StylePanel
 java.awt.Dimension getPreferredSize()
          Retrieves the size at which the Plot Area panel looks best.
 TitlePanel getTitlePanel()
          Retrive TitlePanel working with current StylePanel
 boolean isHelpEnabled()
          Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.
 void removeStyleFromList(int index)
          Remove style to Style List
 void setApplicationName(java.lang.String name)
          Specifies the name of application that uses this panel.
 void setCustomObjectManager(CustomObjectManager customObjectManager)
          Specify persistance object manager for StylePanel
 void setErrorHandler(ErrorHandler eh)
          Specifies an error handler for this Style.
 void setFormatsPanel(FormatsPanel formatsPanel)
          Specify FormatsPanel working with current StylePanel
 void setGridView(UIGridView gridView)
          Specifies the gridView whose properties this panel sets.
 void setHelpContextID(java.lang.String strHelpContextID)
          Sets the Help context ID for this panel.
 void setHelpEnabled(boolean bValue)
          Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.
 void setLocale(java.util.Locale loc)
          Specifies the current Locale that the gridView uses.
 void setOptionsPanel(OptionsPanel optionsPanel)
          Specify OptionsPanel working with current StylePanel
 void setTitlePanel(TitlePanel titlePanel)
          Specify TitlePanel working with current StylePanel

 

Methods inherited from interface java.awt.event.ItemListener
itemStateChanged

 

Methods inherited from interface java.beans.PropertyChangeListener
propertyChange

 

Methods inherited from interface javax.swing.event.ChangeListener
stateChanged

 

Methods inherited from interface java.awt.event.ActionListener
actionPerformed

 

Methods inherited from interface javax.swing.event.ListSelectionListener
valueChanged

 

Constructor Detail

StylePanel

public StylePanel(UIGridView gridView)
Constructor.
Parameters:
gridView - The GridView to which this object belongs.
Method Detail

setGridView

public void setGridView(UIGridView gridView)
Specifies the gridView whose properties this panel sets. This panel gets information from the gridView that is specified either in this method or in the constructor.
Parameters:
gridView - The gridView whose properties this panel sets.

getGridView

public UIGridView getGridView()
Retrive the gridView whose properties this panel sets. This panel gets information from the gridView that is specified either in this method or in the constructor.
Parameters:
gridView - The gridView whose properties this panel sets.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)
Specifies an error handler for this Style. If an error handler has been set, then this Style reports error conditions to the handler. Otherwise, it prints the stack trace.
Parameters:
eh - The error handler that this panel should use.

getErrorHandler

public ErrorHandler getErrorHandler()
Retrieves the error handler that this Style uses.
Returns:
The error handler for this panel, or null if no error handler has been set.

cleanUp

public void cleanUp()
Clean up the inner classes and components

setLocale

public void setLocale(java.util.Locale loc)
Specifies the current Locale that the gridView uses.
Overrides:
setLocale in class java.awt.Component
Parameters:
loc - The current Locale.

getHelpContextID

public java.lang.String getHelpContextID()
Retrieves the Help context ID for this panel. The Help context ID is the full class path for this panel. This Help context ID is used when listening for the user event to display Help for this panel.
Specified by:
getHelpContextID in interface HelpContext
Returns:
The Help context ID for this panel.

setHelpContextID

public void setHelpContextID(java.lang.String strHelpContextID)
Sets the Help context ID for this panel.
Specified by:
setHelpContextID in interface HelpContext
Following copied from interface: oracle.dss.util.help.HelpContext
Parameters:
strHelpContextID - a String value that represents the Help context ID.

apply

public boolean apply()
Applies to the gridView the changes that have been made to this panel. Normally, you call this method in the listener for the container's OK button.

addStyleToList

public void addStyleToList(UIStyle style)
Add new style to Style List
Parameters:
style - the new style to be added to list.

removeStyleFromList

public void removeStyleFromList(int index)
Remove style to Style List
Parameters:
index - the index of style to be removed from list.

setCustomObjectManager

public void setCustomObjectManager(CustomObjectManager customObjectManager)
Specify persistance object manager for StylePanel
Parameters:
CustomObjectManager - persistance object manager.

getCustomObjectManager

public CustomObjectManager getCustomObjectManager()
Retrives persistance object manager for StylePanel
Returns:
CustomObjectManager persistance object manager.

getPreferredSize

public java.awt.Dimension getPreferredSize()
Retrieves the size at which the Plot Area panel looks best. The size is expressed as a Dimension object. If no panel size has been specified, then the preferred size is the default size of the panel.
Overrides:
getPreferredSize in class javax.swing.JComponent
Returns:
A Dimension object that specifies the size for the Plot Area panel.

setApplicationName

public void setApplicationName(java.lang.String name)
Specifies the name of application that uses this panel. Passing the name of your application to this message ensures that alerts that this panel produces are labeled as coming from your application.
Parameters:
name - The name to display in alerts that this panel produces. In localized versions, pass a localized String.

getApplicationName

public java.lang.String getApplicationName()
Retrieves the name of the application that uses this panel. This is the application that alerts appear to come from.
Returns:
The name of the application that uses this panel.

getMinimumSize

public java.awt.Dimension getMinimumSize()
Retrieves the minimum size of the Plot Area panel. The minimum size is the smallest size that the panel can be made without truncating its components in the UI. The size is expressed as a Dimension object.
Overrides:
getMinimumSize in class javax.swing.JComponent
Returns:
A Dimension object that specifies the smallest size that the panel can be made without truncating its components in the UI.

setHelpEnabled

public void setHelpEnabled(boolean bValue)
Specifies whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would specify whether that Help button is displayed.

Parameters:
bValue - true to display the Help button, false to hide it.

isHelpEnabled

public boolean isHelpEnabled()
Indicates whether a Help button in a dialog box that is displayed by this panel, is displayed.

For example, suppose that this panel had a font button and that font button displayed a font dialog box. If that font dialog box had a Help button, then this method would tell you whether that Help button is displayed.

Returns:
true if the Help button is hidden, false if it is displayed.

setFormatsPanel

public void setFormatsPanel(FormatsPanel formatsPanel)
Specify FormatsPanel working with current StylePanel
Parameters:
formatsPanel - instance of FormatsPanel

setOptionsPanel

public void setOptionsPanel(OptionsPanel optionsPanel)
Specify OptionsPanel working with current StylePanel
Parameters:
optionsPanel - instance of OptionsPanel

setTitlePanel

public void setTitlePanel(TitlePanel titlePanel)
Specify TitlePanel working with current StylePanel
Parameters:
titlePanel - instance of TitlePanel

getFormatsPanel

public FormatsPanel getFormatsPanel()
Retrive FormatsPanel working with current StylePanel
Returns:
instance of FormatsPanel

getOptionsPanel

public OptionsPanel getOptionsPanel()
Retrive OptionsPanel working with current StylePanel
Returns:
instance of OptionsPanel

getTitlePanel

public TitlePanel getTitlePanel()
Retrive TitlePanel working with current StylePanel
Returns:
instance of TitlePanel

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


Copyright © 2003, Oracle. All Rights Reserved.