Package com.dassault_systemes.catjdialog

   
Class CATWebPartFrame

 
Class Hierarchy
java.lang.Object
  |
  +-com.dassault_systemes.catjdialog.CATCallbackSource
        |
        +-com.dassault_systemes.catjdialog.CATDialog
              |
              +-com.dassault_systemes.catjdialog.CATWebPartFrame
Class Location

Framework : CATJDialog

Module : CATJDialog

Class Description

public class CATWebPartFrame

The webpart frame graphical component.

Presentation:

This is a bordered frame with a title and a possible icon. This container supports only one child component, that is the content it will display.

CATWebPartFrame Properties:

CATWebPartFrame Notifications:

CATWebPartFrame Message Catalog Implicit Mappings:

   All Implemented Interfaces:
CATIContainerDialog
Field Summary

Constructor Summary
CATWebPartFrame(CATDialog iParent, String iName)

Method Summary
boolean getBorder()
void setBorder(boolean iHasBorder)
String getTitle()
void setTitle(String iTitle)
String getStyle()
void setStyle(String iStyle)
CATDialog getContent()


Field Detail

Constructor Detail

CATWebPartFrame

    CATWebPartFrame(CATDialog iParent, String iName)

Creates a webpart frame with the specified parent and name.

Parameters:
iParent
The parent component.
iName
This webpart frame name. Here are some rules for this name:
  • It is set in the constructor, and cannot be changed afterwards.
  • The name must be unique for the parent (2 children with the same name are not allowed).
  • The name may not contain any ot the following characters: '.' (dot), ' ' (blank), '_' (underscore)

Method Detail

getBorder

    boolean getBorder()

Determines whether the border is displayed or not.

Returns:
true if the border is displayed; false otherwise.

setBorder

    void setBorder(boolean iHasBorder)

Shows/hides the border.

Parameters:
iHasBorder
If true, the border is displayed; otherwise it is hidden.

getTitle

    String getTitle()

Returns the webpart frame's title.

Returns the programmatic value if setTitle() has been called, or tries to retrieve its title from the associated message catalog file (<label_path>.Title entry).

Returns:
This webpart frame's title.

setTitle

    void setTitle(String iTitle)

Sets the webpart frame's title.

Calling this method sets programmatically the title. This should be reserved for cases where the title can only be determined by dynamic means.
The standard way of defining components messages is using CATNls catalog files (supports NLS).

Parameters:
iTitle
The string that is to be this webpart frame's title.

getStyle

    String getStyle()

Returns the webpart icon URI. Default is null (no icon).

Returns:
The style icon URI.

setStyle

    void setStyle(String iStyle)

Sets the webpart icon URI. There is no default icon.

Parameters:
iStyle
An icon URI. It can be either a relative path from the resources/graphic directory of the runtime view, or a full URL to an image resource. A null value unsets the icon in this webpart frame.

getContent

    CATDialog getContent()

Get the child widget that is the content of this webpart frame.

Returns:
The top content component.
See Also:
CATIContainerDialog#getContent()


Copyright © 2000, Dassault Systèmes. All rights reserved