Skip to content
Reference > Classes

DividerPanel

Definition

DividerPanel var = .... ;

Extends

Extended By

None

Description

A panel for Dividers

Method Summary

Owner Name Return Type Description
Panel addPanelNextToMe(position, configuration) DividerPanel Adds a new panel adjacent to this panel by creating a divider portlet. The divider portlet is returned.
Panel bringToFront() Object Makes this panel visible and bring its containing window to the front.
Panel callCommand(applicationId, cmdId, arguments) String Calls the given command. Returns commandUid (String) on success, otherwise null.
Panel callCommand(applicationId, cmdId, arguments) String Calls the given command. Returns the commandUid (String) for this command call or null on failure.
Panel callRelationship(relationshipName) Boolean Reruns the relationship targeting this panel based on name. Returns true on success.
Panel callRelationshipId(relationshipId) Boolean Reruns the relationship targeting this panel based on id. Returns true on success.
Panel clearUserSelection() Object Clears the user's selection.
Panel close() Object Removes this transient panel. Note this will throw an error if the target panel is not transient.
Panel deletePanel() Object Removes this transient panel. Note this will throw an error if the target panel is not transient
Panel exportConfig() Map Exports this panel's configuration to a map.
Panel exportConfig(includeRelationships, includeDatamodels) Map Exports this panel's configuration to a map, with the options to include external relationships and external datamodels.
Panel exportConfigIncludeExternalRelationships() Map Exports this panels configuration with external relationships
Panel exportUserPreferences() Map Exports this panel's user preferences to a map.
DashboardResource getCallback(callbackName) Callback Returns a callback by name
DashboardResource getCallbacks() Map Returns a map of all callback definitions.
DashboardResource getChildren() List Returns a list of the child dashboard resources.
Object getClassName() String Returns the string name of this object's class type.
Panel getCurrentRelationship() Relationship Returns the Relationship object currently applied to this panel.
DashboardResource getDRI() String Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
DashboardResource getDashboardResourceType() String Returns the Dashboard Resource Type as a string
Panel getDatamodels() Object Returns a set of datamodels that were used in this panel.
DividerPanel getDividerOffsetPct() Double Returns a Double that is the offset value.
DividerPanel getDividerOffsetPx() Integer Returns an Integer that is the numerical offset value.
Panel getDownstreamMode() String Returns status of send data downstream to realtime panels. The statuses are OFF or SELECTED_OR_ALL.
DividerPanel getFirstChild() Object Returns the first child of the divider.
DashboardResource getFormula(formulaName) Formula Returns a Formula given the formula name.
DashboardResource getFormulaNames() Set Returns a set of the names of all formulas for this object.
DashboardResource getFormulas() Map Returns a map of all available formulas for this object. The key is the formula name.
Panel getId() String Returns this panel's ID (as defined in settings).
DashboardResource getLRI() String Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
Panel getLayout() Layout Returns layout that owns this panel.
Panel getLocation() Rectangle Returns a Rectangle object that stores the location of this panel relative to the upper left corner of the browser, not including the 3Forge header.
Panel getMenu() MenuItem Returns this panel's root custom context menu.
DashboardResource getOwner() DashboardResource Returns the DashboardResource that owns this object.
Panel getParent() Panel Returns the parent panel of this panel.
DividerPanel getSecondChild() Object Returns the second child of the divider.
DividerPanel getSnapDirection() String Returns snap direction. Possible return values: none, (right/left (if divider is vertical), top/bottom (if divider is horizontal).
Panel getStyle(styleKey) String Returns the value for a particular style given the style code, which can be obtained by clicking on the style name. Returns Null if key not found.
Panel getStyle(styleKey, index) String Returns the value for a particular style given the style code at the specified position. The style code can be obtained by clicking on the style name. Returns Null if key not found, returns the first value in the list if position is out of bound.
Panel getStyleNumber(styleKey) Number Returns the numeric value associated with the supplied style key in this portlets style. Null if key not found, or value is not a number. Ex: using this method for text align will return null as its values are not numeric.
Panel getStyleSet() StyleSet Returns the StyleSet for this panel.
Panel getTitle() String Returns this panel's title
Panel getType() String Returns the type of this panel, either: html, div_v, div_h, tabs, or one of the AMI visualization types.
Panel getUid() String Returns this panel's ami-generated ID.
Panel getValue(key) Object Returns the value associated with key from this portlet's attributes. Returns null if key does not exist.
Panel getWindow() Window Returns the window that owns this panel.
DashboardResource invokeCallback(callbackName, args) Object Executes the specified callback definition and returns the result from the callback.
DividerPanel isHorizontal() Boolean Returns true if it is a horizontal divider, false otherwise.
Panel isPoppedOut() Boolean Returns true if this panel is popped out.
DividerPanel isSnapped() Boolean Returns true if divider is currently snapped, false otherwise.
DashboardResource isTransient() Boolean Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
Panel isUndocked() Boolean Returns true if this panel is undocked.
DividerPanel isVertical() Boolean Returns true if it is a vertical divider, false otherwise.
Panel isVisible() Boolean Returns true if this panel is visible.
Panel minimize() Object Minimizes the window, same as calling getWindow().minimize().
DividerPanel setDividerOffsetPct(offset) Boolean Sets the offset of the divider. E.g. setting the offset to 0.3 means the left panel of the divider will have 30% of the area, while the right panel will have 70%.
DividerPanel setDividerOffsetPx(offset) Boolean Sets the offset of the divider.
Panel setDownstreamMode(mode) String Sets and returns the mode for sending data downstream to realtime panels. The modes are OFF or SELECTED_OR_ALL.
DividerPanel setSnapDirection(snapDirection) Boolean Sets the direction of snap. Accepted values: left/right (if divider is vertical), top/bottom (if divider is horizontal). Returns true if successful, false otherwise.
Panel setTitle(title) Boolean Sets the title of the panel with the given value
Panel setValue(key, value) Boolean Adds the key value pair to this portlet's attributes and return true if successful.
DividerPanel snap() Boolean Snaps the divider to the position specified in the divider settings.
Object toJson() String Returns a json representation of this object.
DividerPanel unsnap() Boolean Brings back the divider to the position before it was snapped.

Method Definitions


getDividerOffsetPct()

Double DividerPanel::getDividerOffsetPct()

Description

Returns a Double that is the offset value.


getDividerOffsetPx()

Integer DividerPanel::getDividerOffsetPx()

Description

Returns an Integer that is the numerical offset value.


getFirstChild()

Object DividerPanel::getFirstChild()

Description

Returns the first child of the divider.


getSecondChild()

Object DividerPanel::getSecondChild()

Description

Returns the second child of the divider.


getSnapDirection()

String DividerPanel::getSnapDirection()

Description

Returns snap direction. Possible return values: none, (right/left (if divider is vertical), top/bottom (if divider is horizontal).


isHorizontal()

Boolean DividerPanel::isHorizontal()

Description

Returns true if it is a horizontal divider, false otherwise.


isSnapped()

Boolean DividerPanel::isSnapped()

Description

Returns true if divider is currently snapped, false otherwise.


isVertical()

Boolean DividerPanel::isVertical()

Description

Returns true if it is a vertical divider, false otherwise.


setDividerOffsetPct(offset)

Boolean DividerPanel::setDividerOffsetPct(Double offset)

Description

Sets the offset of the divider. E.g. setting the offset to 0.3 means the left panel of the divider will have 30% of the area, while the right panel will have 70%.

Parameter Definition

Name Type Description
offset Double  numerical offset value between 0 - 1 inlcusive.

setDividerOffsetPx(offset)

Boolean DividerPanel::setDividerOffsetPx(Integer offset)

Description

Sets the offset of the divider.

Parameter Definition

Name Type Description
offset Integer  numerical offset value.

setSnapDirection(snapDirection)

Boolean DividerPanel::setSnapDirection(String snapDirection)

Description

Sets the direction of snap. Accepted values: left/right (if divider is vertical), top/bottom (if divider is horizontal). Returns true if successful, false otherwise.

Parameter Definition

Name Type Description
snapDirection String  Direction of the snap.

snap()

Boolean DividerPanel::snap()

Description

Snaps the divider to the position specified in the divider settings.


unsnap()

Boolean DividerPanel::unsnap()

Description

Brings back the divider to the position before it was snapped.