MindFusion.Java Package Programmer's Guide
CheckBoxComponent Members
Constructors Fields Methods
 


Displays a check-box that lets users select true / false values.

The following tables list the members exposed by the CheckBoxComponent type.

 Public Constructors

  Name Description

CheckBoxComponent

Initializes a new instance of the CheckBoxComponent class.

 Protected Fields

  Name Description

eventListenerList

  (Inherited from ComponentBase.)

 Public Methods

  Name Description

accept

ComponentBase.accept override. (Inherited from ContentComponent.)

addButtonComponentListener

Registers an event listener. (Inherited from ButtonComponent.)

addChild

Implements AddChild.addChild (Inherited from ContentComponent.)

addComponentEventListener

Adds the specified component listener to receive events from this component. (Inherited from ComponentBase.)

addComponentMouseEventListener

Adds the specified component listener to receive events from this component. (Inherited from ComponentBase.)

addComponentValidationEventListener

Adds the specified component listener to receive events from this component. (Inherited from ComponentBase.)

arrangeComponents

ComponentBase.arrangeComponents override. (Inherited from ContentComponent.)

confirmValidating

Confirms validation by raising the Validating event. (Inherited from ComponentBase.)

contains

Checks if the specified component is contained in the hierarchy defined by the current component. (Inherited from ComponentBase.)

createOutlinePath

For internal use. (Inherited from ComponentBase.)

draw

ButtonComponent.draw override.

find

Returns the component with the specified name within the hierarchy defined by the current component. (Inherited from ComponentBase.)

getBounds

Gets the calculated bounds of this component relative to its parent. (Inherited from ComponentBase.)

getBrush

Gets the background brush of the button when it is in normal state. (Inherited from ButtonComponent.)

getBrushHovered

Gets the background brush of the button when it is in hovered state. (Inherited from ButtonComponent.)

getBrushPressed

Gets the background brush of the button when it is in pressed state. (Inherited from ButtonComponent.)

getCheckedImageList

Gets a list with images. Each image in the list represents the appearance of the check box in its checked state: 0 - normal, 1 - pressed, 2 - disabled, 3 - hovered.

getChildCount

ComponentBase.getChildCount override. (Inherited from ContentComponent.)

getContent

Gets the content of this component. (Inherited from ContentComponent.)

getCursor

ComponentBase.getCursor override. (Inherited from ButtonComponent.)

getDesiredSize

ComponentBase.getDesiredSize override. (Inherited from ButtonComponent.)

getDocumentBounds

For internal use. (Inherited from ComponentBase.)

getFocusable

Gets a value indicating whether the component can receive the input focus. (Inherited from ComponentBase.)

getGridColumn

Gets the index of the grid column this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

getGridRow

Gets the index of the grid row this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

getHeight

Gets the explicit height of this component. (Inherited from ComponentBase.)

getHorizontalAlignment

Gets the horizontal alignment of this component relative to its parent. (Inherited from ComponentBase.)

getImageList

Gets a list with images. Each image in the list represents the appearance of the button in one of its states: 0 - normal, 1 - pressed, 2 - disabled, 3 - hovered. (Inherited from ButtonComponent.)

getIsEnabled

Gets a value indicating whether the component is enabled. (Inherited from ComponentBase.)

getIsFocused

Gets a value indicating whether this component currently holds the input focus. (Inherited from ComponentBase.)

getIsHitTestVisible

Gets a value indicating whether this component and all its children are subject to hit-testing operations. (Inherited from ComponentBase.)

getIsInteractive

Gets a value indicating whether this component can be interacted with. (Inherited from ComponentBase.)

getName

Gets the name of the component. (Inherited from ComponentBase.)

getPadding

Gets the padding around this component's content. (Inherited from ContentComponent.)

getParent

Gets the parent component, if the current component is hosted. (Inherited from ComponentBase.)

getParentHost

For internal use. (Inherited from ComponentBase.)

getPen

Gets the border pen of the button when it is in normal state. (Inherited from ButtonComponent.)

getPenHovered

Gets the border pen of the button when it is in hovered state. (Inherited from ButtonComponent.)

getPenPressed

Gets the border pen of the button when it is in pressed state. (Inherited from ButtonComponent.)

getType

Gets the type of the button. (Inherited from ButtonComponent.)

getVerticalAlignment

Gets the vertical alignment of this component relative to its parent. (Inherited from ComponentBase.)

getVisible

Gets a value indicating whether the component is visible. (Inherited from ComponentBase.)

getWidth

Gets the explicit width of this component. (Inherited from ComponentBase.)

invalidate

Invalidates the visual appearance of the component. (Inherited from ComponentBase.)

invalidateLayout

Invalidates the layout of this component and all its children. (Inherited from ComponentBase.)

isChecked

Gets a value indicating whether the check box is checked.

onContextChanged

  (Inherited from ComponentBase.)

onKeyDown

ComponentBase.onKeyDown override. (Inherited from ButtonComponent.)

onKeyPress

Called when a character key is pressed when this component has the input focus. (Inherited from ComponentBase.)

onKeyUp

  (Inherited from ComponentBase.)

onMouseDown

ComponentBase.onMouseDown override. (Inherited from ButtonComponent.)

onMouseMove

ComponentBase.onMouseMove override. (Inherited from ButtonComponent.)

onMouseUp

ComponentBase.onMouseUp override. (Inherited from ButtonComponent.)

onUnitChanged

Invoked when the measure unit of the document containing the component has changed. (Inherited from ComponentBase.)

raiseValidated

  (Inherited from ComponentBase.)

readExternal

ComponentBase.readExternal override.

removeButtonComponentListener

Unregisters an event listener. (Inherited from ButtonComponent.)

removeComponentEventListener

Removes the specified component listener to not receive events from this component. (Inherited from ComponentBase.)

removeComponentMouseEventListener

Removes the specified component listener to not receive events from this component. (Inherited from ComponentBase.)

removeComponentValidationEventListener

Removes the specified component listener to not receive events from this component. (Inherited from ComponentBase.)

setBounds

Sets the calculated bounds of this component relative to its parent. (Inherited from ComponentBase.)

setBrush

Sets the background brush of the button when it is in normal state. (Inherited from ButtonComponent.)

setBrushHovered

Sets the background brush of the button when it is in hovered state. (Inherited from ButtonComponent.)

setBrushPressed

Sets the background brush of the button when it is in pressed state. (Inherited from ButtonComponent.)

setCheckedImageList

Sets a list with images. Each image in the list represents the appearance of the check box in its checked state: 0 - normal, 1 - pressed, 2 - disabled, 3 - hovered.

setContent

Sets the content of this component. (Inherited from ContentComponent.)

setFocusable

Sets a value indicating whether the component can receive the input focus. (Inherited from ComponentBase.)

setGridColumn

Sets the index of the grid row this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

setGridRow

Sets the index of the grid row this component will be associated with when added to a GridPanel. (Inherited from ComponentBase.)

setHeight

Sets the explicit height of this component. (Inherited from ComponentBase.)

setHorizontalAlignment

Sets the horizontal alignment of this component relative to its parent. (Inherited from ComponentBase.)

setImageList

Sets a list with images. Each image in the list represents the appearance of the button in one of its states: 0 - normal, 1 - pressed, 2 - disabled, 3 - hovered. (Inherited from ButtonComponent.)

setIsChecked

Sets a value indicating whether the check box is checked.

setIsEnabled

Sets a value indicating whether the component is enabled. (Inherited from ComponentBase.)

setIsFocused

Sets a value indicating whether this component currently holds the input focus. (Inherited from ComponentBase.)

setIsHitTestVisible

Sets a value indicating whether this component and all its children are subject to hit-testing operations. (Inherited from ComponentBase.)

setIsInteractive

Sets a value indicating whether this component can be interacted with. (Inherited from ComponentBase.)

setName

Sets the name of the component. (Inherited from ComponentBase.)

setPadding

Sets the padding around this component's content. (Inherited from ContentComponent.)

setParent

For internal use. (Inherited from ComponentBase.)

setPen

Sets the border pen of the button when it is in normal state. (Inherited from ButtonComponent.)

setPenHovered

Sets the border pen of the button when it is in hovered state. (Inherited from ButtonComponent.)

setPenPressed

Sets the border pen of the button when it is in pressed state. (Inherited from ButtonComponent.)

setType

Sets the type of the button. (Inherited from ButtonComponent.)

setVerticalAlignment

Sets the vertical alignment of this component relative to its parent. (Inherited from ComponentBase.)

setVisible

Sets a value indicating whether the component is visible. (Inherited from ComponentBase.)

setWidth

Sets the explicit width of this component. (Inherited from ComponentBase.)

toDocument

Converts a point from local to document coordinates. (Inherited from ComponentBase.)

toLocal

Converts a point from document to local coordinates. (Inherited from ComponentBase.)

toParent

Converts a point from local coordinates to the specified parent's coordinates. (Inherited from ComponentBase.)

writeExternal

ComponentBase.writeExternal override.

 Protected Methods

  Name Description

fireCustomDraw

Raises the customDraw event. (Inherited from ButtonComponent.)

fireOnClicked

Raises the mouseClicked event. (Inherited from ButtonComponent.)

fireRepeatEnded

Raises the repeatEnded event. (Inherited from ButtonComponent.)

getImage

ButtonComponent.getImage override.

getState

Gets the current state of the button (Inherited from ButtonComponent.)

getThickness

Gets the space around the component's content. This space includes padding by default but can be subsequently adjusted as necessary by the deriving classes. (Inherited from ContentComponent.)

loadFromJson

 

loadFromXml

ComponentBase.loadFromXml override.

onAddedToParent

Invoked when the component is added to a parent component. (Inherited from ComponentBase.)

onGotFocus

Overloaded.   (Inherited from ComponentBase.)

onLostFocus

Overloaded.   (Inherited from ComponentBase.)

onRemovedFromParent

Invoked when the component is removed from a parent component. (Inherited from ComponentBase.)

onValidated

Raises the Validated event. (Inherited from ComponentBase.)

onValidating

Raises the Validating event. (Inherited from ComponentBase.)

onZoomChanged

Invoked when the zoom factor of the document containing the component has changed. (Inherited from ComponentBase.)

saveToJson

 

saveToXml

ComponentBase.saveToXml override.

serializeSubcomponents

Invoked to query whether the underlying component structure should be automatically serialized or serialized by the user. (Inherited from ComponentBase.)

 See Also

CheckBoxComponent Class
com.mindfusion.diagramming.components Namespace