ObjectInfoWidget
implements GuiElement| com.microstrategy.web.app.gui.ObjectInfoWidget |
Class Overview
The ObjectInfo Widget renders the information about a WebObjectInfo.
It's the GUIElement used to render a single object information, such
as name, description, icon, modification time, etc.
Calling renderElement() will render the ObjectInfo using default values.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | FIELD_DESCRIPTION | Constant representing the field for Description. | |||||||||
| int | FIELD_ICON | Constant representing the field for Icon. | |||||||||
| int | FIELD_MODIFIED | Constant representing the field for Modified. | |||||||||
| int | FIELD_NAME | Constant representing the field for Name. | |||||||||
| int | FIELD_OWNER | Constant representing the field for Owner. | |||||||||
| int | LEVEL_ALL | Constant representing all the fields. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String |
getCssPrefix()
Returns the prefix used for the name of the css classes used by this widget
| ||||||||||
| abstract String |
getDatamartImage()
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract String |
getDocumentImage()
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract String |
getGraphImage()
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract String |
getGridImage()
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract int |
getLevel()
Returns the current level Flag.
| ||||||||||
| abstract WebObjectInfo |
getObjectInfo()
Returns the current objectInfo displaying
| ||||||||||
| abstract String |
getRwDocumentImage()
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract void |
setCssPrefix(String name)
Sets a prefix to use for the name of the css classes used rendering object info
| ||||||||||
| abstract void |
setDatamartImage(String name)
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract void |
setDocumentImage(String name)
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract void |
setGraphImage(String name)
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract void |
setGridImage(String name)
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
| abstract void |
setLevel(int level)
Sets the level Flag.
| ||||||||||
| abstract void |
setObjectInfo(WebObjectInfo info)
Sets the ObjectInfo of the object to display.
| ||||||||||
| abstract void |
setRwDocumentImage(String name)
This method is deprecated.
the image to use is now defined by css class
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From interface
com.microstrategy.web.app.gui.GuiElement
| |||||||||||
Constants
public static final int FIELD_DESCRIPTION
Constant representing the field for Description. Value is 4.
public static final int FIELD_ICON
Constant representing the field for Icon. Value is 1.
public static final int FIELD_MODIFIED
Constant representing the field for Modified. Value is 16.
public static final int FIELD_NAME
Constant representing the field for Name. Value is 2.
public static final int FIELD_OWNER
Constant representing the field for Owner. Value is 32.
public static final int LEVEL_ALL
Constant representing all the fields. Value is 65535.
Public Methods
public abstract String getCssPrefix ()
Returns the prefix used for the name of the css classes used by this widget
Returns
- the prefix.
public abstract String getDatamartImage ()
This method is deprecated.
the image to use is now defined by css class
Returns the name of the image used to display datamart reports
Returns
- the name of the image
public abstract String getDocumentImage ()
This method is deprecated.
the image to use is now defined by css class
Returns the name of the image used to display documents
Returns
- the name of the image
public abstract String getGraphImage ()
This method is deprecated.
the image to use is now defined by css class
Returns the name of the image used to display graph reports
Returns
- the name of the image
public abstract String getGridImage ()
This method is deprecated.
the image to use is now defined by css class
Returns the name of the image used to display grid reports
Returns
- the name of the image
public abstract int getLevel ()
Returns the current level Flag. This flag indicates which fields to display when using default rendering
Returns
- the current level
public abstract WebObjectInfo getObjectInfo ()
Returns the current objectInfo displaying
Returns
- the objectInfo
public abstract String getRwDocumentImage ()
This method is deprecated.
the image to use is now defined by css class
Returns the name of the image used to display report writing documents
Returns
- the name of the image
public abstract void setCssPrefix (String name)
Sets a prefix to use for the name of the css classes used rendering object info
Parameters
| name | the prefix to use |
|---|
public abstract void setDatamartImage (String name)
This method is deprecated.
the image to use is now defined by css class
Sets the name of the image to use for datamart Reports
Parameters
| name | name of the image |
|---|
public abstract void setDocumentImage (String name)
This method is deprecated.
the image to use is now defined by css class
Sets the name of the image to use for documents
Parameters
| name | name of the image |
|---|
public abstract void setGraphImage (String name)
This method is deprecated.
the image to use is now defined by css class
Sets the name of the image to use for graph Reports
Parameters
| name | name of the image |
|---|
public abstract void setGridImage (String name)
This method is deprecated.
the image to use is now defined by css class
Sets the name of the image to use for grid Reports
Parameters
| name | name of the image |
|---|
public abstract void setLevel (int level)
Sets the level Flag. This flag indicates which fields to display when using default rendering
Parameters
| level | a flagged value of the fields to display |
|---|
public abstract void setObjectInfo (WebObjectInfo info)
Sets the ObjectInfo of the object to display.
Parameters
| info | the WebObjectInfo |
|---|
public abstract void setRwDocumentImage (String name)
This method is deprecated.
the image to use is now defined by css class
Sets the name of the image to use for report writing documents
Parameters
| name | name of the image |
|---|