public class DrillOutLink
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
a_id |
protected static java.lang.String |
a_label |
protected static java.lang.String |
a_type |
protected static java.lang.String |
a_value |
protected static java.lang.String |
DRILL_OUT_LINK_NAME |
protected static java.lang.String |
s_drillOut |
protected static java.lang.String |
s_id |
protected static java.lang.String |
s_label |
protected static java.lang.String |
s_type |
protected static java.lang.String |
s_url |
protected static java.lang.String |
s_value |
protected static java.lang.String |
s_worksheet_ref |
protected static java.lang.String |
url |
static int |
URL
Type: The
Value is a URL string |
protected static java.lang.String |
worksheet_ref |
static int |
WORKSHEET_REFERENCE
Type: The
Value is a Worksheet Reference |
Constructor and Description |
---|
DrillOutLink(int type,
java.lang.String value,
java.lang.String label,
java.lang.String id)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object object)
Checks whether the specified DrillOutLink is identical to this DrillOutLink instance.
|
java.lang.String |
getID()
Retrieves the unique ID for this
DrillOutLink . |
java.lang.String |
getLabel()
Retrieves the label that appears in the popup for a cell that
has a
DrillOutLink . |
protected oracle.dss.util.xml.ObjectNode |
getStateAsObjectNode()
Retrieves XML that represents properties and their values in the form
of and
ObjectNode . |
int |
getType()
Retrieves the type of link that this
DrillOutLink is. |
java.lang.String |
getValue()
Retrieves the worksheet reference or a URL to which this
DrillOutLink directs a user. |
protected oracle.dss.util.xml.ObjectNode |
getXML(boolean allProperties)
Retrieves XML that represents properties and their values in the form
of and
ObjectNode . |
void |
setLabel(java.lang.String label)
Specifies the label that appears in the popup for a cell that
has a
DrillOutLink . |
protected void |
setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node)
Specifies XML that represents properties and values.
|
void |
setType(int type)
Specifies the type of link that this
DrillOutLink is. |
void |
setValue(java.lang.String value)
Specifies the worksheet reference or a URL to which this
DrillOutLink directs a user. |
protected void |
setXML(oracle.dss.util.xml.ObjectNode node)
Specifies XML that represents properties and values.
|
public static final int URL
Value
is a URL stringpublic static final int WORKSHEET_REFERENCE
Value
is a Worksheet Referenceprotected static final java.lang.String DRILL_OUT_LINK_NAME
protected static final java.lang.String a_type
protected static final java.lang.String a_value
protected static final java.lang.String a_label
protected static final java.lang.String a_id
protected static final java.lang.String url
protected static final java.lang.String worksheet_ref
protected static final java.lang.String s_drillOut
protected static final java.lang.String s_type
protected static final java.lang.String s_value
protected static final java.lang.String s_label
protected static final java.lang.String s_id
protected static final java.lang.String s_url
protected static final java.lang.String s_worksheet_ref
public DrillOutLink(int type, java.lang.String value, java.lang.String label, java.lang.String id)
type
- A constant that identifies the type of information that
the value
argument holds.
Valid constants are listed in the See Also section.value
- Where to link to.
If type
is WORKSHEET_REFERENCE
,
then pass a String
representation of a
worksheet reference, including the worksheet name and any
tokens that are needed.
If type
is URL
, then
pass a tokenized URL.label
- The label that should appear in the popup. This
is the text that the user clicks on to drill out.id
- A unique ID for this DrillOutLink
.
This ID is used to determine whether the same value
and label
can be used in multiple cells.URL
,
WORKSHEET_REFERENCE
public int getType()
DrillOutLink
is.
The Type
property determines how the Value
property is interpreted.Value
is a worksheet reference or a URL.URL
,
WORKSHEET_REFERENCE
public void setType(int type)
DrillOutLink
is.
The Type
property determines how the Value
property is interpreted.type
- A constant that identifies whether the Value
is a worksheet reference or a URL.URL
,
WORKSHEET_REFERENCE
public java.lang.String getValue()
DrillOutLink
directs a user.public void setValue(java.lang.String value)
DrillOutLink
directs a user.value
- The worksheet reference or URL to which this object links.public java.lang.String getLabel()
DrillOutLink
.public void setLabel(java.lang.String label)
DrillOutLink
.label
- The label to display in the popup.public java.lang.String getID()
DrillOutLink
.
You can use the same DrillOutLink
for more than one cell.DrillOutLink
.protected oracle.dss.util.xml.ObjectNode getXML(boolean allProperties)
ObjectNode
.allProperties
- true
to store all property values in XML,
false
to store only values that are different
from default values.protected void setXML(oracle.dss.util.xml.ObjectNode node)
node
- ObjectNode
that has the properties and their values.protected oracle.dss.util.xml.ObjectNode getStateAsObjectNode()
ObjectNode
.allProperties
- true
to store all property values in XML,
false
to store only values that are different
from default values.protected void setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node)
node
- ObjectNode
that has the properties and their values.public boolean equals(java.lang.Object object)
equals
in class java.lang.Object