Package com.microstrategy.web.app.gui
Interface ObjectInfoWidget
-
- All Superinterfaces:
GuiElement
public interface ObjectInfoWidget extends GuiElement
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.- Since:
- MicroStrategy Web 7.3.1 or earlier
-
-
Field Summary
Fields Modifier and Type Field Description static int
FIELD_DESCRIPTION
Constant representing the field for Description.static int
FIELD_ICON
Constant representing the field for Icon.static int
FIELD_MODIFIED
Constant representing the field for Modified.static int
FIELD_NAME
Constant representing the field for Name.static int
FIELD_OWNER
Constant representing the field for Owner.static int
LEVEL_ALL
Constant representing all the fields.
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description java.lang.String
getCssPrefix()
Returns the prefix used for the name of the css classes used by this widgetjava.lang.String
getDatamartImage()
Deprecated.the image to use is now defined by css classjava.lang.String
getDocumentImage()
Deprecated.the image to use is now defined by css classjava.lang.String
getGraphImage()
Deprecated.the image to use is now defined by css classjava.lang.String
getGridImage()
Deprecated.the image to use is now defined by css classint
getLevel()
Returns the current level Flag.WebObjectInfo
getObjectInfo()
Returns the current objectInfo displayingjava.lang.String
getRwDocumentImage()
Deprecated.the image to use is now defined by css classvoid
setCssPrefix(java.lang.String name)
Sets a prefix to use for the name of the css classes used rendering object infovoid
setDatamartImage(java.lang.String name)
Deprecated.the image to use is now defined by css classvoid
setDocumentImage(java.lang.String name)
Deprecated.the image to use is now defined by css classvoid
setGraphImage(java.lang.String name)
Deprecated.the image to use is now defined by css classvoid
setGridImage(java.lang.String name)
Deprecated.the image to use is now defined by css classvoid
setLevel(int level)
Sets the level Flag.void
setObjectInfo(WebObjectInfo info)
Sets the ObjectInfo of the object to display.void
setRwDocumentImage(java.lang.String name)
Deprecated.the image to use is now defined by css class-
Methods inherited from interface com.microstrategy.web.app.gui.GuiElement
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, renderElement, renderElement, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent
-
-
-
-
Field Detail
-
FIELD_ICON
static final int FIELD_ICON
Constant representing the field for Icon. Value is 1.- See Also:
- Constant Field Values
-
FIELD_NAME
static final int FIELD_NAME
Constant representing the field for Name. Value is 2.- See Also:
- Constant Field Values
-
FIELD_DESCRIPTION
static final int FIELD_DESCRIPTION
Constant representing the field for Description. Value is 4.- See Also:
- Constant Field Values
-
FIELD_MODIFIED
static final int FIELD_MODIFIED
Constant representing the field for Modified. Value is 16.- See Also:
- Constant Field Values
-
FIELD_OWNER
static final int FIELD_OWNER
Constant representing the field for Owner. Value is 32.- See Also:
- Constant Field Values
-
LEVEL_ALL
static final int LEVEL_ALL
Constant representing all the fields. Value is 65535.- See Also:
- Constant Field Values
-
-
Method Detail
-
setLevel
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
-
getLevel
int getLevel()
Returns the current level Flag. This flag indicates which fields to display when using default rendering- Returns:
- the current level
-
setObjectInfo
void setObjectInfo(WebObjectInfo info)
Sets the ObjectInfo of the object to display.- Parameters:
info
- the WebObjectInfo
-
getObjectInfo
WebObjectInfo getObjectInfo()
Returns the current objectInfo displaying- Returns:
- the objectInfo
-
setGraphImage
void setGraphImage(java.lang.String name)
Deprecated.the image to use is now defined by css classSets the name of the image to use for graph Reports- Parameters:
name
- name of the image
-
getGraphImage
java.lang.String getGraphImage()
Deprecated.the image to use is now defined by css classReturns the name of the image used to display graph reports- Returns:
- the name of the image
-
setGridImage
void setGridImage(java.lang.String name)
Deprecated.the image to use is now defined by css classSets the name of the image to use for grid Reports- Parameters:
name
- name of the image
-
getGridImage
java.lang.String getGridImage()
Deprecated.the image to use is now defined by css classReturns the name of the image used to display grid reports- Returns:
- the name of the image
-
setDatamartImage
void setDatamartImage(java.lang.String name)
Deprecated.the image to use is now defined by css classSets the name of the image to use for datamart Reports- Parameters:
name
- name of the image- Since:
- MicroStrategy Web 7.5.0
-
getDatamartImage
java.lang.String getDatamartImage()
Deprecated.the image to use is now defined by css classReturns the name of the image used to display datamart reports- Returns:
- the name of the image
- Since:
- MicroStrategy Web 7.5.0
-
setDocumentImage
void setDocumentImage(java.lang.String name)
Deprecated.the image to use is now defined by css classSets the name of the image to use for documents- Parameters:
name
- name of the image
-
getDocumentImage
java.lang.String getDocumentImage()
Deprecated.the image to use is now defined by css classReturns the name of the image used to display documents- Returns:
- the name of the image
-
setRwDocumentImage
void setRwDocumentImage(java.lang.String name)
Deprecated.the image to use is now defined by css classSets the name of the image to use for report writing documents- Parameters:
name
- name of the image- Since:
- MicroStrategy Web 7.5.0
-
getRwDocumentImage
java.lang.String getRwDocumentImage()
Deprecated.the image to use is now defined by css classReturns the name of the image used to display report writing documents- Returns:
- the name of the image
- Since:
- MicroStrategy Web 7.5.0
-
setCssPrefix
void setCssPrefix(java.lang.String name)
Sets a prefix to use for the name of the css classes used rendering object info- Parameters:
name
- the prefix to use
-
getCssPrefix
java.lang.String getCssPrefix()
Returns the prefix used for the name of the css classes used by this widget- Returns:
- the prefix.
-
-