public static interface DataGrid.DataCell extends DataGrid.Cell, DataValue
Modifier and Type | Method and Description |
---|---|
void |
addValidationError(java.lang.Integer bgColor,
java.lang.String tooltip)
Sets the background color and tooltip for this data cell, and vetos
the operation during which this validation error is added.
|
void |
addValidationError(java.lang.Integer bgColor,
java.lang.String tooltip,
boolean isValid)
Sets the background color and tooltip for this data cell, and vetos
the operation during which this validation error is added if isValid
is false.
|
DataGrid.DataCell |
crossDimCell(java.lang.String... mbrNames)
Returns the first matching (top left) cell in this grid that
represents the specified members or null if no matching cells are
found.
|
java.lang.String |
getAccountName()
Returns the account name for this cell.
|
java.lang.String |
getAccountName(MemberNameType memberNameType)
Returns the account name for this cell based on the specified member
name type.
|
java.lang.Integer |
getBgColor()
Returns the background color for this data cell.
|
java.lang.String |
getCurrencyCode()
Returns the currency code for this data if the application is
enabled for multiple currencies.
|
double |
getData()
Returns the data value in this data cell.
|
java.util.Date |
getDataAsDate()
Returns a date representation of the data value in this data cell if
the data type is DATE; otherwise null is returned.
|
java.lang.String |
getDataAsSmartListMemberName()
Returns the name of the member from which this data cell's smart list
value is derived.
|
java.lang.String |
getDataAsSmartListMemberName(MemberNameType memberNameType)
Returns the name of the member based on the specified member name
type from which this data cell's smart list value is derived.
|
DataType |
getDataType()
Returns the data type for this data cell.
|
java.lang.String |
getEntityName()
Returns the entity name for this cell.
|
java.lang.String |
getEntityName(MemberNameType memberNameType)
Returns the entity name for this cell based on the specified member
name type.
|
java.lang.String |
getMemberName(oracle.epm.api.model.DimensionType dimType)
Returns the member name for the specified dimension type that the
cell represents.
|
java.lang.String |
getMemberName(oracle.epm.api.model.DimensionType dimType,
MemberNameType memberNameType)
Returns the member name based on the specified member name type for
the specified dimension type that the cell represents.
|
java.lang.String |
getMemberName(java.lang.String dimName)
Returns the member name for the specified dimension that the cell
represents.
|
java.lang.String |
getMemberName(java.lang.String dimName,
MemberNameType memberNameType)
Returns the member name based on the specified member name type for
the specified dimension that the cell represents.
|
java.util.List<java.lang.String> |
getMemberNames()
Returns a list of members from all dimensions that the cell
represents.
|
java.util.List<java.lang.String> |
getMemberNames(MemberNameType memberNameType)
Returns a list of members based on the specified member name type
from all dimensions that the cell represents.
|
java.lang.String |
getPeriodName()
Returns the period name for this cell.
|
java.lang.String |
getPeriodName(MemberNameType memberNameType)
Returns the period name for this cell based on the specified member
name type.
|
java.lang.String |
getScenarioName()
Returns the scenario name for this cell.
|
java.lang.String |
getScenarioName(MemberNameType memberNameType)
Returns the scenario name for this cell based on the specified member
name type.
|
java.lang.String |
getTooltip()
Returns the tooltip for this data cell.
|
java.lang.String |
getVersionName()
Returns the version name for this cell.
|
java.lang.String |
getVersionName(MemberNameType memberNameType)
Returns the version name for this cell based on the specified member
name type.
|
java.lang.String |
getYearName()
Returns the year name for this cell.
|
java.lang.String |
getYearName(MemberNameType memberNameType)
Returns the year name for this cell based on the specified member
name type.
|
boolean |
hasCellAttach()
Returns true if one or more attachments are present for this
data cell.
|
boolean |
hasCellNote()
Returns true if there is a cell note present for this data cell.
|
boolean |
isEdited()
Returns true if this data cell is edited.
|
boolean |
isForceEditable()
Returns true if this data cell has been forced to be editable.
|
boolean |
isForceReadOnly()
Returns true if this data cell has been forced to be read only.
|
boolean |
isLocked()
Returns true if this data cell is locked.
|
boolean |
isMissing()
Returns true if this data cell value is missing.
|
boolean |
isReadOnly()
Returns true if this data cell is read only.
|
boolean |
isSelected()
Returns true if this data cell is selected.
|
boolean |
isValid()
Returns true if this cell is valid.
|
boolean |
isValidIntersection()
Returns true if this cell represents a valid intersection.
|
void |
setBgColor(java.lang.Integer bgColor)
Set the background color for this data cell.
|
void |
setData(double dataVal)
Set the data value for this data cell.
|
void |
setEdited(boolean edited)
Marks the data cell as edited.
|
void |
setForceEditable(boolean forceEditable)
Forces the cell to be editable.
|
void |
setForceReadOnly(boolean forceReadOnly)
Forces the cell to be read only.
|
void |
setFormattedValue(java.lang.String dataVal)
Set the logical data value for this data cell.
|
void |
setLocked(boolean locked)
Marks the data cell as locked.
|
void |
setTooltip(java.lang.String tooltip)
Set the tooltip for this data cell.
|
getFormattedValue
getDataAsDouble, getFormattedValue
void addValidationError(java.lang.Integer bgColor, java.lang.String tooltip)
bgColor
- background colortooltip
- tooltip descriptionvoid addValidationError(java.lang.Integer bgColor, java.lang.String tooltip, boolean isValid)
bgColor
- background colortooltip
- tooltip descriptionisValid
- indicates whether the cell should be tagged as validDataGrid.DataCell crossDimCell(java.lang.String... mbrNames)
The specified member names can be from zero or more dimensions.
mbrNames
- member namesjava.lang.String getAccountName()
The returned name is based on the default member name type set for the iterator.
getAccountName
in interface DataValue
java.lang.String getAccountName(MemberNameType memberNameType)
getAccountName
in interface DataValue
memberNameType
- member name typejava.lang.Integer getBgColor()
java.lang.String getCurrencyCode()
double getData()
java.util.Date getDataAsDate()
getDataAsDate
in interface DataValue
java.lang.String getDataAsSmartListMemberName()
getDataAsSmartListMemberName
in interface DataValue
java.lang.String getDataAsSmartListMemberName(MemberNameType memberNameType)
getDataAsSmartListMemberName
in interface DataValue
memberNameType
- member name typeDataType getDataType()
java.lang.String getEntityName()
The returned name is based on the default member name type set for the iterator.
getEntityName
in interface DataValue
java.lang.String getEntityName(MemberNameType memberNameType)
getEntityName
in interface DataValue
memberNameType
- member name typejava.lang.String getMemberName(oracle.epm.api.model.DimensionType dimType)
getMemberName
in interface DataValue
dimType
- dimension typejava.lang.String getMemberName(oracle.epm.api.model.DimensionType dimType, MemberNameType memberNameType)
getMemberName
in interface DataValue
dimType
- dimension typememberNameType
- the member name typejava.lang.String getMemberName(java.lang.String dimName)
getMemberName
in interface DataValue
dimName
- Dimension namejava.lang.String getMemberName(java.lang.String dimName, MemberNameType memberNameType)
getMemberName
in interface DataValue
dimName
- Dimension namememberNameType
- the member name typejava.util.List<java.lang.String> getMemberNames()
getMemberNames
in interface DataValue
java.util.List<java.lang.String> getMemberNames(MemberNameType memberNameType)
getMemberNames
in interface DataValue
memberNameType
- member name typejava.lang.String getPeriodName()
The returned name is based on the default member name type set for the iterator.
getPeriodName
in interface DataValue
java.lang.String getPeriodName(MemberNameType memberNameType)
getPeriodName
in interface DataValue
memberNameType
- member name typejava.lang.String getScenarioName()
The returned name is based on the default member name type set for the iterator.
getScenarioName
in interface DataValue
java.lang.String getScenarioName(MemberNameType memberNameType)
getScenarioName
in interface DataValue
memberNameType
- member name typejava.lang.String getTooltip()
java.lang.String getVersionName()
The returned name is based on the default member name type set for the iterator.
getVersionName
in interface DataValue
java.lang.String getVersionName(MemberNameType memberNameType)
getVersionName
in interface DataValue
memberNameType
- member name typejava.lang.String getYearName()
The returned name is based on the default member name type set for the iterator.
getYearName
in interface DataValue
java.lang.String getYearName(MemberNameType memberNameType)
getYearName
in interface DataValue
memberNameType
- member name typeboolean hasCellAttach()
boolean hasCellNote()
boolean isEdited()
boolean isForceEditable()
boolean isForceReadOnly()
boolean isLocked()
boolean isMissing()
boolean isReadOnly()
boolean isSelected()
boolean isValid()
boolean isValidIntersection()
void setBgColor(java.lang.Integer bgColor)
bgColor
- background colorvoid setData(double dataVal)
dataVal
- valuevoid setEdited(boolean edited)
edited
- true to mark the cell as edited or false to mark the
cell as not edited even if it has previously been edited.void setForceEditable(boolean forceEditable)
Forcing a cell to be editable will set force read only flag to false.
This works in conjunction with the read only flag and provides a way to force a cell to be editable:
Effective Readonly | forceEditable | Effective Access |
---|---|---|
true | true | Read / Write |
false | true | Read / Write |
true | false | Read only |
false | false | Read / Write |
Forcing a cell to be editable during load time will allow end users to enter data into the cell and submit it during a save request. Since setting a cell to be editable will not allow the user to persist data at the intersection unless it was originally an editable cell, a Groovy rule should handle the value entered into the cell as it is saved.
For example, one could force an upper level cell to be editable and then allocate the entered value down when the user saves the grid.
forceEditable
- true to treat the cell as editable or false
to use the cell's original accessvoid setForceReadOnly(boolean forceReadOnly)
Forcing a cell to be read only will set force editable flag to false.
This works in conjunction with the read only flag and provides a way to force a cell to be read only:
Original readOnly | forceReadOnly | Effective Access |
---|---|---|
true | true | Read only |
false | true | Read only |
true | false | Read only |
false | false | Read / Write |
forceReadOnly
- true to treat the cell as read only or false
to use the cell's original accessvoid setFormattedValue(java.lang.String dataVal)
dataVal
- logical valuevoid setLocked(boolean locked)
locked
- true to mark the cell as locked or false to mark the
cell as not locked even if it has previously been locked.void setTooltip(java.lang.String tooltip)
tooltip
- tooltip descriptionCopyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.